- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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.
HTTP request
PATCH https://compute.googleapis.com/compute/beta/projects/{project}/global/interconnects/{interconnect}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
interconnect |
Name of the interconnect to update. |
Query parameters
Parameters | |
---|---|
request |
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 ( |
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 |
[Output Only] Type of the resource. Always |
description |
An optional description of this resource. Provide this property when you create the resource. |
self |
[Output Only] Server-defined URL for the resource. |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creation |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
location |
URL of the InterconnectLocation object that represents where this connection is to be provisioned. |
link |
Type of link requested, which can take one of the following values:
|
requested |
Target number of physical links in the link bundle, as requested by the customer. |
interconnect |
Type of interconnect, which can take one of the following values:
|
admin |
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. |
noc |
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. |
customer |
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. |
operational |
[Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
|
provisioned |
[Output Only] Number of links actually provisioned in this interconnect. |
interconnect |
[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. |
peer |
[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. |
google |
[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. |
google |
[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. |
expected |
[Output Only] A list of outages expected for this Interconnect. |
expected |
Unique identifier for this outage notification. |
expected |
A description about the purpose of the outage. |
expected |
The party that generated this notification, which can take the following value:
|
expected |
State of this notification, which can take one of the following values:
|
expected |
Form this outage is expected to take, which can take one of the following values:
|
expected |
If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. |
expected |
Scheduled start time for the outage (milliseconds since Unix epoch). |
expected |
Scheduled end time for the outage (milliseconds since Unix epoch). |
circuit |
[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. |
circuit |
Google-assigned unique ID for this circuit. Assigned at circuit turn-up. |
circuit |
Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. |
circuit |
Customer-side demarc ID for this circuit. |
labels |
Labels for this resource. These can only be added or modified by the |
label |
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 To see the latest fingerprint, make a A base64-encoded string. |
state |
[Output Only] The current state of Interconnect functionality, which can take one of the following values:
|
satisfies |
[Output Only] Reserved for future use. |
macsec |
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. |
macsec. |
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. |
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 |
macsec. |
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. |
If set to true, the Interconnect connection is configured with a |
macsec |
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. |
remote |
Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. |
requested |
Optional. interconnects.list of features requested for this Interconnect connection, which can take one of the following values:
|
available |
[Output only] interconnects.list of features available for this Interconnect connection, which can take one of the following values:
|
application |
Configuration information for application awareness on this Cloud Interconnect. |
application |
|
application |
|
application |
Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. |
application |
TrafficClass whose bandwidth percentage is being specified. |
application |
Bandwidth percentage for a specific traffic class. |
application |
Description for the application awareness profile on this Cloud Interconnect. |
application |
Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. |
application |
TrafficClass whose bandwidth percentage is being specified. |
application |
Bandwidth percentage for a specific traffic class. |
aai |
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 |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creation |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the operation. |
zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
client |
[Output Only] The value of |
operation |
[Output Only] The type of operation, such as |
target |
[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. |
target |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
status |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[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. |
insert |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
start |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
end |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error. |
[Output Only] The array of errors encountered while processing this operation. |
error. |
[Output Only] The error type identifier for this error. |
error. |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error. |
[Output Only] An optional, human-readable error message. |
error. |
[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. |
|
error. |
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 |
error. |
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. |
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. |
|
error. |
The Compute Engine quota metric name. |
error. |
The name of the quota limit. |
error. |
The map holding related quota dimensions. |
error. |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
error. |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
error. |
Rollout status of the future quota limit. |
error. |
|
error. |
URL(s) pointing to additional information on handling the current error. |
error. |
Describes what the link offers. |
error. |
The URL of the link. |
error. |
|
error. |
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. |
The localized error message in the above locale. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[]. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[]. |
[Output Only] A human-readable description of the warning code. |
warnings[]. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[]. |
[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 |
warnings[]. |
[Output Only] A warning data value corresponding to the key. |
http |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
http |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
self |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
operation |
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a |
Union field metadata . [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following: |
|
set |
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
set |
[Output Only] The client operation id. |
set |
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a |
set |
[Output Only] Status of the action, which can be one of the following: |
set |
[Output Only] If state is |
set |
The status code, which should be an enum value of |
set |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
set |
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 |
instances |
|
instances |
Status information per location (location name is key). Example key: zones/us-central1-a |
instances |
[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. |
instances |
[Output Only] Count of VMs originally planned to be created. |
instances |
[Output Only] Count of VMs successfully created so far. |
instances |
[Output Only] Count of VMs that started creating but encountered an error. |
instances |
[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.get
compute.interconnects.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.