Method: interconnects.get

Returns the specified interconnect. globalOperations.get a list of available interconnects by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/interconnects/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the interconnect to return.

Request body

The request body must be empty.

Response body

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

Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page.

JSON representation
{
  "description": string,
  "selfLink": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "location": string,
  "linkType": enum,
  "requestedLinkCount": number,
  "interconnectType": enum,
  "adminEnabled": boolean,
  "nocContactEmail": string,
  "customerName": string,
  "operationalStatus": enum,
  "provisionedLinkCount": number,
  "interconnectAttachments": [
    string
  ],
  "peerIpAddress": string,
  "googleIpAddress": string,
  "googleReferenceId": string,
  "expectedOutages": [
    {
      "name": string,
      "description": string,
      "source": enum,
      "state": enum,
      "issueType": enum,
      "affectedCircuits": [
        string
      ],
      "startTime": string,
      "endTime": string
    }
  ],
  "circuitInfos": [
    {
      "googleCircuitId": string,
      "googleDemarcId": string,
      "customerDemarcId": string
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "state": enum,
  "kind": string
}
Fields
description

string

An optional description of this resource. Provide this property when you create the resource.

id

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

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.

location

string

URL of the InterconnectLocation object that represents where this connection is to be provisioned.

interconnectType

enum

Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED"

adminEnabled

boolean

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

nocContactEmail

string

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.

customerName

string

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

operationalStatus

enum

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

interconnectAttachments[]

string

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

peerIpAddress

string

[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

googleIpAddress

string

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

googleReferenceId

string

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

expectedOutages[]

object

[Output Only] A list of outages expected for this Interconnect.

expectedOutages[].name

string

Unique identifier for this outage notification.

expectedOutages[].description

string

A description about the purpose of the outage.

expectedOutages[].source

enum

The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE"

expectedOutages[].state

enum

State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values.

expectedOutages[].issueType

enum

Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values.

expectedOutages[].affectedCircuits[]

string

If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.

expectedOutages[].startTime

string (int64 format)

Scheduled start time for the outage (milliseconds since Unix epoch).

expectedOutages[].endTime

string (int64 format)

Scheduled end time for the outage (milliseconds since Unix epoch).

circuitInfos[]

object

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

circuitInfos[].googleCircuitId

string

Google-assigned unique ID for this circuit. Assigned at circuit turn-up.

circuitInfos[].googleDemarcId

string

Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

circuitInfos[].customerDemarcId

string

Customer-side demarc ID for this circuit.

labels

map (key: string, value: string)

Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve an Interconnect.

A base64-encoded string.

state

enum

[Output Only] The current state of whether or not this Interconnect is functional.

kind

string

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

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 Authentication Overview.

IAM Permissions

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

  • compute.interconnects.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine