GOgoogle
interconnects

PATCH /projects/{project}/global/interconnects/{interconnect}

Changed on

Updates the specified Interconnect with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/global/interconnects/{interconnect}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute

Path parameters

projectstring required

Project ID for this request.

interconnectstring required

Name of the interconnect to update.

Query parameters

requestIdstring

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

aaiEnabledboolean

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

adminEnabledboolean

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.

availableFeaturesstring[]

[Output only] 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.
creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

customerNamestring

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

descriptionstring

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

effectiveLocationstring

Output only. URL of the InterconnectLocation object that represents where this connection is to be provisioned. By default it will be the same as the location field.

googleIpAddressstring

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

googleReferenceIdstring

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

idstring uint64

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

interconnectAttachmentsstring[]

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

interconnectGroupsstring[]

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

interconnectType'DEDICATED' | 'IT_PRIVATE' | 'PARTNER'

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.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.

labelFingerprintstring byte

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 error412 conditionNotMet.

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

labelsobject

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

linkType'LINK_TYPE_ETHERNET_100G_LR' | 'LINK_TYPE_ETHERNET_10G_LR' | 'LINK_TYPE_ETHERNET_400G_LR4'

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.

Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

locationstring

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

macsecEnabledboolean

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

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

nocContactEmailstring

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.

operationalStatus'OS_ACTIVE' | 'OS_UNPROVISIONED'

Output only. [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.

peerIpAddressstring

Output only. [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.

provisionedLinkCountinteger

Output only. [Output Only] Number of links actually provisioned in this interconnect.

remoteLocationstring

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

requestedFeaturesstring[]

Optional. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. 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.
requestedLinkCountinteger

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

satisfiesPzsboolean

Output only. [Output Only] Reserved for future use.

selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

selfLinkWithIdstring

Output only. Server-defined URL for this resource with the resource id.

state'ACTIVE' | 'UNPROVISIONED'

Output only. [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.
subzone'SUBZONE_A' | 'SUBZONE_B'

To be deprecated.

wireGroupsstring[]

Output only. [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.

Response

Successful response

clientOperationIdstring

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

creationTimestampstring

[Deprecated] This field is deprecated.

descriptionstring

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

endTimestring

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

httpErrorMessagestring

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

httpErrorStatusCodeinteger

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

idstring uint64

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

insertTimestring

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

kindstring

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

namestring

[Output Only] Name of the operation.

operationGroupIdstring

Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

operationTypestring

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

progressinteger

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

regionstring

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

selfLinkstring

[Output Only] Server-defined URL for the resource.

startTimestring

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

status'DONE' | 'PENDING' | 'RUNNING'

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

statusMessagestring

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

targetIdstring uint64

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

targetLinkstring

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.

userstring

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

zonestring

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

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c