Method: interconnects.insert

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

HTTP request

POST https://compute.googleapis.com/compute/beta/projects/{project}/global/interconnects

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains data with the following structure:

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
  ],
  "applicationAwareInterconnect": {
    "strictPriorityPolicy": ,
    "bandwidthPercentagePolicy": {
      "bandwidthPercentages": [
        {
          "trafficClass": enum,
          "percentage": integer
        }
      ]
    },
    "profileDescription": string,
    "shapeAveragePercentages": [
      {
        "trafficClass": enum,
        "percentage": integer
      }
    ]
  },
  "aaiEnabled": boolean
}
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

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

    Authorization requires the following IAM permission on the specified resource labels:

    • compute.interconnects.setLabels
    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.
    applicationAwareInterconnect

    object

    Configuration information for application awareness on this Cloud Interconnect.
    applicationAwareInterconnect.strictPriorityPolicy

    object
    applicationAwareInterconnect.bandwidthPercentagePolicy

    object
    applicationAwareInterconnect.bandwidthPercentagePolicy.bandwidthPercentages[]

    object

    Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent.
    applicationAwareInterconnect.bandwidthPercentagePolicy.bandwidthPercentages[].trafficClass

    enum

    TrafficClass whose bandwidth percentage is being specified.
    applicationAwareInterconnect.bandwidthPercentagePolicy.bandwidthPercentages[].percentage

    integer (uint32 format)

    Bandwidth percentage for a specific traffic class.
    applicationAwareInterconnect.profileDescription

    string

    Description for the application awareness profile on this Cloud Interconnect.
    applicationAwareInterconnect.shapeAveragePercentages[]

    object

    Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy.
    applicationAwareInterconnect.shapeAveragePercentages[].trafficClass

    enum

    TrafficClass whose bandwidth percentage is being specified.
    applicationAwareInterconnect.shapeAveragePercentages[].percentage

    integer (uint32 format)

    Bandwidth percentage for a specific traffic class.
    aaiEnabled

    boolean

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

    Response body

    Represents an Operation resource.

    Google Compute Engine has three Operation resources:

    You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

    Operations can be global, regional or zonal.

    • For global operations, use the globalOperations resource.
    • For regional operations, use the regionOperations resource.
    • For zonal operations, use the zoneOperations resource.

    For more information, read Global, Regional, and Zonal Resources.

    Note that completed Operation resources have a limited retention period.

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

    JSON representation 
    {
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string,
        "errorDetails": [
          {
            "errorInfo": {
              "reason": string,
              "domain": string,
              "metadatas": {
                string: string,
                ...
              }
            },
            "quotaInfo": {
              "metricName": string,
              "limitName": string,
              "dimensions": {
                string: string,
                ...
              },
              "limit": number,
              "futureLimit": number,
              "rolloutStatus": enum
            },
            "help": {
              "links": [
                {
                  "description": string,
                  "url": string
                }
              ]
            },
            "localizedMessage": {
              "locale": string,
              "message": string
            }
          }
        ]
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "operationGroupId": string,

  // Union field metadata can be only one of the following:
  "setCommonInstanceMetadataOperationMetadata": {
    "clientOperationId": string,
    "perLocationOperations": {
      string: {
        "state": enum,
        "error": {
          "code": integer,
          "message": string,
          "details": [
            {
              "@type": string,
              field1: ...,
              ...
            }
          ]
        }
      },
      ...
    }
  },
  "instancesBulkInsertOperationMetadata": {
    "perLocationStatus": {
      string: {
        "status": enum,
        "targetVmCount": integer,
        "createdVmCount": integer,
        "failedToCreateVmCount": integer,
        "deletedVmCount": integer
      },
      ...
    }
  }
  // End of list of possible types for union field metadata.
}
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#operation for Operation resources.
    id

    string (uint64 format)

    [Output Only] The unique identifier for the operation. This identifier is defined by the server.
    creationTimestamp

    string

    [Deprecated] This field is deprecated.
    name

    string

    [Output Only] Name of the operation.
    zone

    string

    [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
    clientOperationId

    string

    [Output Only] The value of requestId if you provided it in the request. Not present otherwise.
    operationType

    string

    [Output Only] The type of operation, such as insert, update, or delete, and so on.
    targetId

    string (uint64 format)

    [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    status

    enum

    [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    statusMessage

    string

    [Output Only] An optional textual description of the current status of the operation.
    user

    string

    [Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).
    progress

    integer

    [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
    insertTime

    string

    [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    startTime

    string

    [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    endTime

    string

    [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    error

    object

    [Output Only] If errors are generated during processing of the operation, this field will be populated.
    error.errors[]

    object

    [Output Only] The array of errors encountered while processing this operation.
    error.errors[].code

    string

    [Output Only] The error type identifier for this error.
    error.errors[].location

    string

    [Output Only] Indicates the field in the request that caused the error. This property is optional.
    error.errors[].message

    string

    [Output Only] An optional, human-readable error message.
    error.errors[].errorDetails[]

    object

    [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
    error.errors[].errorDetails[].errorInfo

    object
    error.errors[].errorDetails[].errorInfo.reason

    string

    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
    error.errors[].errorDetails[].errorInfo.domain

    string

    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    error.errors[].errorDetails[].errorInfo.metadatas

    map (key: string, value: string)

    Additional structured details about this error.

    Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    error.errors[].errorDetails[].quotaInfo

    object
    error.errors[].errorDetails[].quotaInfo.metricName

    string

    The Compute Engine quota metric name.
    error.errors[].errorDetails[].quotaInfo.limitName

    string

    The name of the quota limit.
    error.errors[].errorDetails[].quotaInfo.dimensions

    map (key: string, value: string)

    The map holding related quota dimensions.
    error.errors[].errorDetails[].quotaInfo.limit

    number

    Current effective quota limit. The limit's unit depends on the quota type or metric.
    error.errors[].errorDetails[].quotaInfo.futureLimit

    number

    Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
    error.errors[].errorDetails[].quotaInfo.rolloutStatus

    enum

    Rollout status of the future quota limit.
    error.errors[].errorDetails[].help

    object
    error.errors[].errorDetails[].help.links[]

    object

    URL(s) pointing to additional information on handling the current error.
    error.errors[].errorDetails[].help.links[].description

    string

    Describes what the link offers.
    error.errors[].errorDetails[].help.links[].url

    string

    The URL of the link.
    error.errors[].errorDetails[].localizedMessage

    object
    error.errors[].errorDetails[].localizedMessage.locale

    string

    The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
    error.errors[].errorDetails[].localizedMessage.message

    string

    The localized error message in the above locale.
    warnings[]

    object

    [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
    warnings[].code

    enum

    [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
    warnings[].message

    string

    [Output Only] A human-readable description of the warning code.
    warnings[].data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example: 

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    warnings[].data[].key

    string

    [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
    warnings[].data[].value

    string

    [Output Only] A warning data value corresponding to the key.
    httpErrorStatusCode

    integer

    [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
    httpErrorMessage

    string

    [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    region

    string

    [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
    description

    string

    [Output Only] A textual description of the operation, which is set when the operation is created.
    operationGroupId

    string

    [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
    Union field metadata. [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following:
    setCommonInstanceMetadataOperationMetadata

    object

    [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
    setCommonInstanceMetadataOperationMetadata.clientOperationId

    string

    [Output Only] The client operation id.
    setCommonInstanceMetadataOperationMetadata.perLocationOperations[]

    map (key: string, value: object)

    [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state

    enum

    [Output Only] Status of the action, which can be one of the following: PROPAGATING, PROPAGATED, ABANDONED, FAILED, or DONE.
    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error

    object

    [Output Only] If state is ABANDONED or FAILED, this field is populated.
    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code

    integer

    The status code, which should be an enum value of google.rpc.Code.
    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message

    string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]

    object

    A list of messages that carry the error details. There is a common set of message types for APIs to use.

    An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.
    instancesBulkInsertOperationMetadata

    object
    instancesBulkInsertOperationMetadata.perLocationStatus[]

    map (key: string, value: object)

    Status information per location (location name is key). Example key: zones/us-central1-a
    instancesBulkInsertOperationMetadata.perLocationStatus[].status

    enum

    [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
    instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount

    integer

    [Output Only] Count of VMs originally planned to be created.
    instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount

    integer

    [Output Only] Count of VMs successfully created so far.
    instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount

    integer

    [Output Only] Count of VMs that started creating but encountered an error.
    instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount

    integer

    [Output Only] Count of VMs that got deleted during rollback.

    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 IAM permissions:

    • compute.interconnects.create

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles.