Stay organized with collections Save and categorize content based on your preferences.
Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list()
request.
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
Project ID for this request.
interconnectRemoteLocation
string
Name of the interconnect remote location to return.
Request bodyThe request body must be empty.
Response bodyRepresents 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.
selfLink
string
[Output Only] Server-defined URL for 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:
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:
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.
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 PermissionsIn 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["This document outlines the details for retrieving information about interconnect remote locations, essential for managing Cross-Cloud Interconnect resources."],["The `GET` request method is used, with the required URL structure provided, including path parameters for `project` and `interconnectRemoteLocation`."],["The response body, structured in JSON format, provides comprehensive details about the interconnect remote location, including its type, description, ID, status, and constraints."],["Authorization for this API requires specific OAuth scopes or IAM permissions, such as `compute.interconnectRemoteLocations.get`, to ensure secure access."],["The remote location contains information about permitted connections, link aggregation group constraints and attachment configurations."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4