Console
Start free

Method: interconnectGroups.list

Lists the InterconnectGroups for a project in the given scope.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/global/interconnectGroups

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

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)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
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.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "selfLink": string,
      "etag": string,
      "interconnects": {
        string: {
          "interconnect": string
        },
        ...
      },
      "intent": {
        "topologyCapability": enum
      },
      "physicalStructure": {
        "metros": [
          {
            "metro": string,
            "facilities": [
              {
                "facility": string,
                "zones": [
                  {
                    "zone": string,
                    "interconnects": [
                      string
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      "configured": {
        "topologyCapability": {
          "supportedSla": enum,
          "intendedCapabilityBlockers": [
            {
              "blockerType": enum,
              "explanation": string,
              "documentationLink": string,
              "metros": [
                string
              ],
              "facilities": [
                string
              ],
              "zones": [
                string
              ],
              "interconnects": [
                string
              ]
            }
          ]
        }
      }
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields kind

string

id

string

Output only. Unique identifier for the resource; defined by the server.

items[]

object

A list of InterconnectGroup resources.

items[].kind

string

Output only. Type of the resource. Always compute#InterconnectGroup

items[].id

string (uint64 format)

Output only. The unique identifier for the resource type. The server generates this identifier.

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

string

Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by AIP 154.

items[].interconnects[]

map (key: string, value: object)

Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota.

items[].interconnects[].interconnect

string

The URL of an Interconnect in this group. All Interconnects in the group are unique.

items[].intent

object

items[].intent.topologyCapability

enum

items[].physicalStructure

object

items[].physicalStructure.metros[]

object

items[].physicalStructure.metros[].metro

string

Output only. The name of the metro, as a three-letter lowercase string like "iad". This is the first component of the location of Interconnects underneath this.

items[].physicalStructure.metros[].facilities[]

object

items[].physicalStructure.metros[].facilities[].facility

string

Output only. The ID of this facility, as a numeric string like "5467". This is the third component of the location of Interconnects in this facility.

items[].physicalStructure.metros[].facilities[].zones[]

object

items[].physicalStructure.metros[].facilities[].zones[].zone

string

Output only. The name of the zone, either "zone1" or "zone2". This is the second component of the location of Interconnects in this facility.

items[].physicalStructure.metros[].facilities[].zones[].interconnects[]

string

Output only. URLs of Interconnects in this redundancy group in the given metro, facility, and zone.

items[].configured

object

items[].configured.topologyCapability

object

items[].configured.topologyCapability.supportedSla

enum

items[].configured.topologyCapability.intendedCapabilityBlockers[]

object

items[].configured.topologyCapability.intendedCapabilityBlockers[].blockerType

enum

items[].configured.topologyCapability.intendedCapabilityBlockers[].explanation

string

Output only. A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.

items[].configured.topologyCapability.intendedCapabilityBlockers[].documentationLink

string

Output only. The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement.

items[].configured.topologyCapability.intendedCapabilityBlockers[].metros[]

string

Output only. Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". A blocker like INCOMPATIBLE_METROS will specify the problematic metros in this field.

items[].configured.topologyCapability.intendedCapabilityBlockers[].facilities[]

string

Output only. Facilities used to explain this blocker in more detail. Like physicalStructure.metros.facilities.facility, this is a numeric string like "5467".

items[].configured.topologyCapability.intendedCapabilityBlockers[].zones[]

string

Output only. Zones used to explain this blocker in more detail. Zone names are "zone1" and/or "zone2".

items[].configured.topologyCapability.intendedCapabilityBlockers[].interconnects[]

string

Output only. Interconnects used to explain this blocker in more detail.

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

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.

etag

string

unreachables[]

string

Output only. Unreachable resources. end_interface: MixerListResponseWithEtagBuilder

Authorization scopes

Requires one of the following OAuth scopes:

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 IAM permissions:

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.