Method: interconnectAttachments.get

Returns the specified interconnect attachment.

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/interconnectAttachments/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region for this request.

resourceId

string

Name of the interconnect attachment to return.

Request body

The request body must be empty.

Response body

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

Response for InterconnectAttachmentsGetRequest.

JSON representation
{
  "resource": {
    "description": string,
    "selfLink": string,
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "interconnect": string,
    "router": string,
    "region": string,
    "googleReferenceId": string,
    "privateInterconnectInfo": {
      "tag8021q": number
    },
    "operationalStatus": enum,
    "cloudRouterIpAddress": string,
    "customerRouterIpAddress": string,
    "kind": string
  }
}
Fields
resource

object

resource.description

string

An optional description of this resource.

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.id

string (fixed64 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

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

resource.interconnect

string

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

resource.router

string

URL of the cloud router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

resource.region

string

[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

resource.googleReferenceId

string

[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

resource.privateInterconnectInfo

object

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

resource.privateInterconnectInfo.tag8021q

number

[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

resource.operationalStatus

enum

[Output Only] The current status of whether or not this interconnect attachment is functional.

resource.cloudRouterIpAddress

string

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

resource.customerRouterIpAddress

string

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

resource.kind

string

[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.interconnectAttachments.get

Send feedback about...

Compute Engine