/

Console

• English
• Deutsch
• Español – América Latina
• Français
• Português – Brasil
• 中文 – 简体
• 日本語
• 한국어

Sign in

• Compute Engine

Start free

Method: interconnects.get

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
    • JSON representation
    • JSON representation
    • JSON representation
    • JSON representation
• Authorization scopes
• IAM Permissions
• Try it!

Response body

{
  "kind": string,
  "description": string,
  "selfLink": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "location": string,
  "subzone": enum,
  "linkType": enum,
  "requestedLinkCount": integer,
  "interconnectType": enum,
  "adminEnabled": boolean,
  "nocContactEmail": string,
  "customerName": string,
  "operationalStatus": enum,
  "provisionedLinkCount": integer,
  "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,
  "satisfiesPzs": boolean,
  "macsec": {
    "preSharedKeys": [
      {
        "name": string,
        "startTime": string
      }
    ],
    "failOpen": boolean
  },
  "macsecEnabled": boolean,
  "remoteLocation": string,
  "requestedFeatures": [
    enum
  ],
  "availableFeatures": [
    enum
  ],
  "applicationAwareInterconnect": {
    "strictPriorityPolicy": ,
    "bandwidthPercentagePolicy": {
      "bandwidthPercentages": [
        {
          "trafficClass": enum,
          "percentage": integer
        }
      ]
    },
    "profileDescription": string,
    "shapeAveragePercentages": [
      {
        "trafficClass": enum,
        "percentage": integer
      }
    ]
  },
  "aaiEnabled": boolean,
  "interconnectGroups": [
    string
  ],
  "wireGroups": [
    string
  ],
  "params": {
    "resourceManagerTags": {
      string: string,
      ...
    }
  }
}

string

Output only. Type of the resource. Always compute#interconnect for interconnects.

string

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

string

Output only. Server-defined URL for the resource.

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

string

Output only. Creation timestamp in RFC3339 text format.

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.

string

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

enum

To be deprecated.

enum

Type of link requested, which can take one of the following values:

• LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
• LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
• LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.

integer

Target number of physical links in the link bundle, as requested by the customer.

enum

Type of interconnect, which can take one of the following values:

• PARTNER: A partner-managed interconnection shared between customers though a partner.
• DEDICATED: A dedicated physical interconnection with the customer.

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.

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 Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

string

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

enum

Output only. The current status of this Interconnect's functionality, which can take one of the following values:

• OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.

integer

Output only. Number of links actually provisioned in this interconnect.

string

Output only. A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

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.

string

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

string

Output only. Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

object

Output only. A list of outages expected for this Interconnect.

string

Unique identifier for this outage notification.

string

A description about the purpose of the outage.

enum

The party that generated this notification, which can take the following value:

• GOOGLE: this notification as generated by Google.

enum

State of this notification, which can take one of the following values:

• ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
• CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
• COMPLETED: The outage associated with this notification is complete.

enum

Form this outage is expected to take, which can take one of the following values:

• OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
• PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.

string

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

string (int64 format)

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

string (int64 format)

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

object

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

string

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

string

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

string

Customer-side demarc ID for this circuit.

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

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, otherwise the request will fail with error 412 conditionNotMet.

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

A base64-encoded string.

enum

Output only. The current state of Interconnect functionality, which can take one of the following values:

• ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
• UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
• UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

boolean

Output only. Reserved for future use.

object

Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.

object

Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.

string

Required. A name for this pre-shared key. 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.

string

A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.

boolean

If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

boolean

Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

string

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

enum

Optional. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. interconnects.list of features requested for this Interconnect connection, which can take one of the following values:

• IF_MACSEC: If specified, then the connection is created on MACsec capable hardware ports. If not specified, non-MACsec capable ports will also be considered.
• IF_CROSS_SITE_NETWORK: If specified, then the connection is created exclusively for Cross-Site Networking. The connection can not be used for Cross-Site Networking unless this feature is specified.

enum

Output only. interconnects.list of features available for this Interconnect connection, which can take one of the following values:

• IF_MACSEC: If present, then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present, then the Interconnect connection is provisioned on non-MACsec capable ports. Any attempt to enable MACsec will fail.
• IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is provisioned exclusively for Cross-Site Networking. Any attempt to configure VLAN attachments will fail. If not present, then the Interconnect connection is not provisioned for Cross-Site Networking. Any attempt to use it for Cross-Site Networking will fail.

object

Configuration information for application awareness on this Cloud Interconnect.

object

object

object

Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent.

enum

TrafficClass whose bandwidth percentage is being specified.

integer (uint32 format)

Bandwidth percentage for a specific traffic class.

string

Description for the application awareness profile on this Cloud Interconnect.

object

Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy.

enum

TrafficClass whose bandwidth percentage is being specified.

integer (uint32 format)

Bandwidth percentage for a specific traffic class.

boolean

Enable or disable the application awareness feature on this Cloud Interconnect.

string

Output only. URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique.

string

Output only. A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.

object

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

map (key: string, value: string)