Method: interconnects.list

Retrieves the list of interconnect available to the specified project.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/interconnects

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

number (uint32 format)

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)

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.

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).

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response to the list request, and contains a list of interconnects.

JSON representation
{
  "id": string,
  "items": [
    {
      "description": string,
      "selfLink": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "location": string,
      "linkType": enum,
      "requestedLinkCount": number,
      "interconnectType": enum,
      "adminEnabled": boolean,
      "nocContactEmail": string,
      "customerName": string,
      "operationalStatus": enum,
      "provisionedLinkCount": number,
      "interconnectAttachments": [
        string
      ],
      "peerIpAddress": string,
      "googleIpAddress": string,
      "googleReferenceId": string,
      "expectedOutages": [
        {
          "name": string,
          "description": string,
          "source": enum,
          "state": enum,
          "issueType": enum,
          "affectedCircuits": [
            string
          ],
          "startTime": string,
          "endTime": string
        }
      ],
      "circuitInfos": [
        {
          "googleCircuitId": string,
          "googleDemarcId": string,
          "customerDemarcId": string
        }
      ],
      "labels": {
        "key": string,
        "value": string
      },
      "labelFingerprint": string,
      "state": enum,
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "kind": string
}
Fields
id

string

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

items[]

object

A list of Interconnect resources.

items[].description

string

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

items[].selfLink

string

[Output Only] Server-defined URL for the resource.

items[].id

string (fixed64 format)

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

items[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

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[].location

string

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

items[].linkType

enum

Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. Only 10G per link is allowed for a dedicated interconnect. Options: Ethernet_10G_LR

items[].requestedLinkCount

number

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

items[].interconnectType

enum

Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED"

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[].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[].customerName

string

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

items[].operationalStatus

enum

[Output Only] The current status of whether or not this Interconnect is functional.

items[].provisionedLinkCount

number

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

items[].interconnectAttachments[]

string

[Output Only] A list of the URLs of all InterconnectAttachments configured to use 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[].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[].expectedOutages[]

object

[Output Only] A list of outages expected for this Interconnect.

items[].expectedOutages[].name

string

Unique identifier for this outage notification.

items[].expectedOutages[].description

string

A description about the purpose of the outage.

items[].expectedOutages[].source

enum

The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE"

items[].expectedOutages[].state

enum

State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values.

items[].expectedOutages[].issueType

enum

Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values.

items[].expectedOutages[].affectedCircuits[]

string

If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

items[].expectedOutages[].startTime

string (int64 format)

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

items[].expectedOutages[].endTime

string (int64 format)

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

items[].circuitInfos[]

object

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

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[].circuitInfos[].customerDemarcId

string

Customer-side demarc ID for this circuit.

items[].labels

map (key: string, value: string)

Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

items[].labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an Interconnect.

A base64-encoded string.

items[].state

enum

[Output Only] The current state of whether or not this Interconnect is functional.

items[].kind

string

[Output Only] Type of the resource. Always compute#interconnect for 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.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[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.message

string

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

warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

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.

kind

string

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

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.interconnects.list
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine