- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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/beta/projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
interconnectRemoteLocation |
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 |
[Output Only] Type of the resource. Always |
description |
[Output Only] An optional description of the resource. |
selfLink |
[Output Only] Server-defined URL for the resource. |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
[Output Only] Name of the resource. |
peeringdbFacilityId |
[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). |
address |
[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. |
facilityProvider |
[Output Only] The name of the provider for this facility (e.g., EQUINIX). |
facilityProviderFacilityId |
[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). |
continent |
[Output Only] Continent for this location, which can take one of the following values:
|
city |
[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". |
status |
[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values:
|
remoteService |
[Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure". |
permittedConnections[] |
[Output Only] Permitted connections. |
permittedConnections[].interconnectLocation |
[Output Only] URL of an Interconnect location that is permitted to connect to this Interconnect remote location. |
constraints |
[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments. |
constraints.subnetLengthRange |
[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 |
|
constraints.subnetLengthRange.max |
|
constraints.portPairVlan |
[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN |
constraints.portPairRemoteLocation |
[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 |
[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote location. |
attachmentConfigurationConstraints.bgpMd5 |
[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[] |
[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 |
|
attachmentConfigurationConstraints.bgpPeerAsnRanges[].max |
|
lacp |
[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED |
maxLagSize100Gbps |
[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 |
[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.