REST Resource: interconnectLocations

Resource: InterconnectLocationsGetResponse

Response for the InterconnectLocationsGetRequest.

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

object

resource.kind

string

Output only. Type of the resource. Always compute#interconnectLocation for interconnect locations.

resource.description

string

Output only. An optional description of the resource.

resource.selfLink

string

Output only. Server-defined URL for the resource.

resource.id

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

resource.creationTimestamp

string

Output only. Creation timestamp in RFC3339 text format.

resource.name

string

Output only. Name of the resource.

resource.peeringdbFacilityId

string

Output only. The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

resource.address

string

Output only. The postal address of the Point of Presence, each line in the address is separated by a newline character.

resource.facilityProvider

string

Output only. The name of the provider for this facility (e.g., EQUINIX).

resource.facilityProviderFacilityId

string

Output only. A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

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

resource.regionInfos[].region

string

Output only. URL for the region of this location.

resource.regionInfos[].expectedRttMs

string (int64 format)

Output only. Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.

resource.regionInfos[].locationPresence

enum

Output only. Identifies the network presence of this location.

resource.regionInfos[].l2ForwardingEnabled

boolean

Output only. Identifies whether L2 Interconnect Attachments can be created in this region for interconnects that are in this location.

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

resource.crossSiteInterconnectInfos[].city

string

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

resource.continent

enum

Output only. Continent for this location, which can take one of the following values:

  • AFRICA
  • ASIA_PAC
  • EUROPE
  • NORTH_AMERICA
  • SOUTH_AMERICA

resource.city

string

Output only. Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".

resource.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".

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

resource.supportsPzs

boolean

Output only. Reserved for future use.

resource.availableFeatures[]

enum

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

  • IF_MACSEC
  • IF_CROSS_SITE_NETWORK

resource.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
  • LINK_TYPE_ETHERNET_400G_LR4

resource.singleRegionProductionCriticalPeerLocations[]

string

Output only. URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.

Methods

get

Returns the details for the specified interconnect location.

list

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