Method: interconnectRemoteLocations.get

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
interconnectRemoteLocation

string

Name of the interconnect remote ___location to return.

Request body

The request body must be empty.

Response body

Represents a Cross-Cloud Interconnect Remote Location resource.

You can use this resource to find remote ___location details about an Interconnect attachment (VLAN).

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,
  "continent": enum,
  "city": string,
  "status": enum,
  "remoteService": string,
  "permittedConnections": [
    {
      "interconnectLocation": string
    }
  ],
  "constraints": {
    "subnetLengthRange": {
      "min": integer,
      "max": integer
    },
    "portPairVlan": enum,
    "portPairRemoteLocation": enum
  },
  "attachmentConfigurationConstraints": {
    "bgpMd5": enum,
    "bgpPeerAsnRanges": [
      {
        "min": integer,
        "max": integer
      }
    ]
  },
  "lacp": enum,
  "maxLagSize100Gbps": integer,
  "maxLagSize10Gbps": integer
}
Fields
kind

string

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

enum

[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values:

  • CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects.
  • AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.
remoteService

string

[Output Only] Indicates the service provider present at the remote ___location. Example values: "Amazon Web Services", "Microsoft Azure".
permittedConnections[]

object

[Output Only] Permitted connections.
permittedConnections[].interconnectLocation

string

[Output Only] URL of an Interconnect ___location that is permitted to connect to this Interconnect remote ___location.
constraints

object

[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.
constraints.subnetLengthRange

object

[Output Only]

[min-length, max-length]

The minimum and maximum value (inclusive) for the IPv4 subnet length.

For example, an interconnectRemoteLocation for Azure has {min: 30, max: 30} because Azure requires /30 subnets.

This range specifies the values supported by both cloud providers. Interconnect currently supports /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint on IPv4 subnet length, the range would thus be {min: 29, max: 30}.
constraints.subnetLengthRange.min

integer
constraints.subnetLengthRange.max

integer
constraints.portPairVlan

enum

[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN
constraints.portPairRemoteLocation

enum

[Output Only] Port pair remote ___location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION.

Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote ___location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote ___location.
attachmentConfigurationConstraints

object

[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote ___location.
attachmentConfigurationConstraints.bgpMd5

enum

[Output Only] Whether the attachment's BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.

For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachmentConfigurationConstraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.
attachmentConfigurationConstraints.bgpPeerAsnRanges[]

object

[Output Only] interconnectRemoteLocations.list of ASN ranges that the remote ___location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534.

This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.
attachmentConfigurationConstraints.bgpPeerAsnRanges[].min

integer (uint32 format)
attachmentConfigurationConstraints.bgpPeerAsnRanges[].max

integer (uint32 format)
lacp

enum

[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED
maxLagSize100Gbps

integer

[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed maxLagSize100Gbps.
maxLagSize10Gbps

integer

[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed maxLagSize10Gbps.

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

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