Method: interconnectLocations.get

Returns the details for the specified interconnect ___location. Gets a list of available interconnect locations by making a list() request.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
interconnectLocation

string

Name of the interconnect ___location to return.

Request body

The request body must be empty.

Response body

Represents an Interconnect Attachment (VLAN) Location resource.

You can use this resource to find ___location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.

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

JSON representation 
{
  "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
    }
  ],
  "crossSiteInterconnectInfos": [
    {
      "city": string
    }
  ],
  "continent": enum,
  "city": string,
  "availabilityZone": string,
  "status": enum,
  "supportsPzs": boolean,
  "availableFeatures": [
    enum
  ],
  "availableLinkTypes": [
    enum
  ]
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
description

string

[Output Only] An optional description of the resource.
id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

[Output Only] Name of the resource.
peeringdbFacilityId

string

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
address

string

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
facilityProvider

string

[Output Only] The name of the provider for this facility (e.g., EQUINIX).
facilityProviderFacilityId

string

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
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.
regionInfos[].region

string

URL for the region of this ___location.
regionInfos[].expectedRttMs

string (int64 format)

Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
regionInfos[].locationPresence

enum

Identifies the network presence of this ___location.
crossSiteInterconnectInfos[]

object

[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this ___location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.
crossSiteInterconnectInfos[].city

string

The remote ___location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations.
continent

enum

[Output Only] Continent for this ___location, which can take one of the following values:

  • AFRICA
  • ASIA_PAC
  • EUROPE
  • NORTH_AMERICA
  • SOUTH_AMERICA
city

string

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
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".
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.
supportsPzs

boolean

[Output Only] Reserved for future use.
availableFeatures[]

enum

[Output only] interconnectLocations.list of features available at this InterconnectLocation, which can take one of the following values:

  • IF_MACSEC

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

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