List

Retrieves the list of interconnect available to the specified project

5 variables
44 variables

Retrieves the list of interconnect available to the specified project

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

filter STRING

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

maxResults INTEGER

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

orderBy STRING

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported

pageToken STRING

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

Output

This building block provides 44 output parameters

  = Parameter name
  = Format

id STRING

[Output Only] Unique identifier for the resource; defined by the server

items[] OBJECT

Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

items[].adminEnabled BOOLEAN

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true

items[].circuitInfos[] OBJECT

Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4

items[].circuitInfos[].customerDemarcId STRING

Customer-side demarc ID for this circuit

items[].circuitInfos[].googleCircuitId STRING

Google-assigned unique ID for this circuit. Assigned at circuit turn-up

items[].circuitInfos[].googleDemarcId STRING

Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA

items[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items[].customerName STRING

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect

items[].description STRING

An optional description of this resource. Provide this property when you create the resource

items[].expectedOutages[] OBJECT

Description of a planned outage on this Interconnect. Next id: 9

items[].expectedOutages[].affectedCircuits[] STRING

items[].expectedOutages[].description STRING

A description about the purpose of the outage

items[].expectedOutages[].endTime INTEGER

Scheduled end time for the outage (milliseconds since Unix epoch)

items[].expectedOutages[].issueType ENUMERATION

Form this outage is expected to take, which can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

items[].expectedOutages[].name STRING

Unique identifier for this outage notification

items[].expectedOutages[].source ENUMERATION

The party that generated this notification, which can take the following value:

  • GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

items[].expectedOutages[].startTime INTEGER

Scheduled start time for the outage (milliseconds since Unix epoch)

items[].expectedOutages[].state ENUMERATION

State of this notification, which can take one of the following values:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

items[].googleIpAddress STRING

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests

items[].googleReferenceId STRING

[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues

items[].id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

items[].interconnectAttachments[] STRING

items[].interconnectType ENUMERATION

Type of interconnect, which can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

items[].kind STRING

[Output Only] Type of the resource. Always compute#interconnect for interconnects

items[].linkType ENUMERATION

Type of link requested, which can take one of the following values:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

items[].location STRING

URL of the InterconnectLocation object that represents where this connection is to be provisioned

items[].name STRING

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash

items[].nocContactEmail STRING

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications

items[].operationalStatus ENUMERATION

[Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

items[].peerIpAddress STRING

[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests

items[].provisionedLinkCount INTEGER

[Output Only] Number of links actually provisioned in this interconnect

items[].requestedLinkCount INTEGER

Target number of physical links in the link bundle, as requested by the customer

items[].selfLink STRING

[Output Only] Server-defined URL for the resource

items[].state ENUMERATION

[Output Only] The current state of Interconnect functionality, which can take one of the following values:

  • ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
  • UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
  • UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

kind STRING

[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects

nextPageToken STRING

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warning.data[] OBJECT

warning.data[].key STRING

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

warning.message STRING

[Output Only] A human-readable description of the warning code