For a list of methods for this resource, see the end of this page.

Resource representations

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 interconnect overview page.

  "kind": "compute#interconnect",
  "description": string,
  "selfLink": string,
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "location": string,
  "linkType": string,
  "requestedLinkCount": integer,
  "interconnectType": string,
  "adminEnabled": boolean,
  "nocContactEmail": string,
  "customerName": string,
  "operationalStatus": string,
  "provisionedLinkCount": integer,
  "connectionAuthorization": string,
  "interconnectAttachments": [
  "peerIpAddress": string,
  "googleIpAddress": string,
  "googleReferenceId": string,
  "expectedOutages": [
      "name": string,
      "description": string,
      "source": string,
      "state": string,
      "issueType": string,
      "affectedCircuits": [
      "startTime": long,
      "endTime": long
  "circuitInfos": [
      "googleCircuitId": string,
      "googleDemarcId": string,
      "customerDemarcId": string
Property name Value Description Notes
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.
circuitInfos[] list [Output Only] List of CircuitInfo objects, that describe the individual circuits in this LAG.
circuitInfos[].customerDemarcId string Customer-side demarc ID for this circuit.

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.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
customerName string Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
description string An optional description of this resource. Provide this property when you create the resource.
expectedOutages[] list [Output Only] List of outages expected for this Interconnect.
expectedOutages[].affectedCircuits[] list Iff issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
expectedOutages[].description string A description about the purpose of the outage.
expectedOutages[].endTime long
expectedOutages[].issueType string
expectedOutages[].name string Unique identifier for this outage notification.
expectedOutages[].source string
expectedOutages[].startTime long Scheduled start and end times for the outage (milliseconds since Unix epoch).
expectedOutages[].state string
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.

id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
interconnectAttachments[] list [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
interconnectType string
kind string [Output Only] Type of the resource. Always compute#interconnect for interconnects.
linkType string
location string URL of the InterconnectLocation object that represents where this connection is to be provisioned.
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.
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.
operationalStatus string [Output Only] The current status of whether or not this Interconnect is functional.
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.
provisionedLinkCount integer [Output Only] Number of links actually provisioned in this interconnect.
requestedLinkCount integer Target number of physical links in the link bundle, as requested by the customer.


Deletes the specified interconnect.
Returns the specified interconnect. Get a list of available interconnects by making a list() request.
Creates a Interconnect in the specified project using the data included in the request.
Retrieves the list of interconnect available to the specified project.
Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Returns permissions that a caller has on the specified resource.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine