Method: interconnectLocations.list

Retrieves the list of interconnect locations available to the specified project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.

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

Response to the list request, and contains a list of interconnect locations.

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

JSON representation
{ "kind": string, "id": string, "items": [ { "kind": string, "description": string, "selfLink": string, "id": string, "creationTimestamp": string, "name": string, "peeringdbFacilityId": string, "address": string, "facilityProvider": string, "facilityProviderFacilityId": string, "regionInfos": [ { "region": string, "expectedRttMs": string, "locationPresence": enum } ], "continent": enum, "city": string, "availabilityZone": string, "status": enum, "supportsPzs": boolean, "availableFeatures": [ enum ], "availableLinkTypes": [ enum ] } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }

JSON representation

{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "description": string,
      "selfLink": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "peeringdbFacilityId": string,
      "address": string,
      "facilityProvider": string,
      "facilityProviderFacilityId": string,
      "regionInfos": [
        {
          "region": string,
          "expectedRttMs": string,
          "locationPresence": enum
        }
      ],
      "continent": enum,
      "city": string,
      "availabilityZone": string,
      "status": enum,
      "supportsPzs": boolean,
      "availableFeatures": [
        enum
      ],
      "availableLinkTypes": [
        enum
      ]
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}

Fields
`kind`	`string` [Output Only] Type of resource. Always `compute#interconnectLocationList` for lists of interconnect locations.
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of InterconnectLocation resources.
`items[].kind`	`string` [Output Only] Type of the resource. Always `compute#interconnectLocation` for interconnect locations.
`items[].description`	`string` [Output Only] An optional description of the resource.
`items[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].id`	`string (uint64 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` [Output Only] Name of the resource.
`items[].peeringdbFacilityId`	`string` [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
`items[].address`	`string` [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
`items[].facilityProvider`	`string` [Output Only] The name of the provider for this facility (e.g., EQUINIX).
`items[].facilityProviderFacilityId`	`string` [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
`items[].regionInfos[]`	`object` [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
`items[].regionInfos[].region`	`string` URL for the region of this location.
`items[].regionInfos[].expectedRttMs`	`string (int64 format)` Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
`items[].regionInfos[].locationPresence`	`enum` Identifies the network presence of this location.
`items[].continent`	`enum` [Output Only] Continent for this location, which can take one of the following values: AFRICA ASIA_PAC EUROPE NORTH_AMERICA SOUTH_AMERICA
`items[].city`	`string` [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
`items[].availabilityZone`	`string` [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".
`items[].status`	`enum` [Output Only] The status of this InterconnectLocation, which can take one of the following values: CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
`items[].supportsPzs`	`boolean` [Output Only] Reserved for future use.
`items[].availableFeatures[]`	`enum` [Output only] interconnectLocations.list of features available at this InterconnectLocation, which can take one of the following values: MACSEC
`items[].availableLinkTypes[]`	`enum` [Output only] interconnectLocations.list of link types available at this InterconnectLocation, which can take one of the following values: LINK_TYPE_ETHERNET_10G_LR LINK_TYPE_ETHERNET_100G_LR
`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.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
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 IAM permissions:

compute.interconnectLocations.list

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