REST Resource: interconnects

Resource: Interconnect

Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.

JSON representation 
{
  "kind": string,
  "description": string,
  "selfLink": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "location": string,
  "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
  ]
}
Fields
kind

string

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

string

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

string (uint64 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, 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.
Note that a value 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 Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.
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 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.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

    		•
    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, which can take the following value:

    • GOOGLE: this notification as generated by Google.
    Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
    expectedOutages[].state

    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.
    Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
    expectedOutages[].issueType

    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.
    Note that the versions of this enum prefixed with "IT_" 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 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.
    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, 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.
    state

    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.
    satisfiesPzs

    boolean

    [Output Only] Reserved for future use.
    macsec

    object

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

    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.
    macsec.preSharedKeys[].name

    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.
    macsec.preSharedKeys[].startTime

    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.
    macsec.failOpen

    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.
    macsecEnabled

    boolean

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

    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.
    requestedFeatures[]

    enum

    Optional. 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, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.
    availableFeatures[]

    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 and MACsec isn't supported and enabling MACsec fails.

    Methods

    delete

    		 Deletes the specified Interconnect.

    get

    		 Returns the specified Interconnect.

    getDiagnostics

    		 Returns the interconnectDiagnostics for the specified Interconnect.

    getMacsecConfig

    		 Returns the interconnectMacsecConfig for the specified Interconnect.

    insert

    		 Creates an Interconnect in the specified project using the data included in the request.

    list

    		 Retrieves the list of Interconnects available to the specified project.

    patch

    		 Updates the specified Interconnect with the data included in the request.

    setLabels

    		 Sets the labels on an Interconnect.