Console
    Contact Us Start free

    Method: interconnectAttachments.insert

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

    HTTP request

    POST https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/interconnectAttachments

    The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

    Path parameters

    Parameters
    project

    string

    Project ID for this request.
    region

    string

    Name of the region 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 ).
    validateOnly

    boolean

    If true, the request will not be committed.

    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 
 , 
 "interconnect" 
 : 
 string 
 , 
 "router" 
 : 
 string 
 , 
 "region" 
 : 
 string 
 , 
 "googleReferenceId" 
 : 
 string 
 , 
 "mtu" 
 : 
 integer 
 , 
 "privateInterconnectInfo" 
 : 
 { 
 "tag8021q" 
 : 
 integer 
 } 
 , 
 "operationalStatus" 
 : 
 enum 
 , 
 "cloudRouterIpAddress" 
 : 
 string 
 , 
 "customerRouterIpAddress" 
 : 
 string 
 , 
 "type" 
 : 
 enum 
 , 
 "pairingKey" 
 : 
 string 
 , 
 "adminEnabled" 
 : 
 boolean 
 , 
 "vlanTag8021q" 
 : 
 integer 
 , 
 "edgeAvailabilityDomain" 
 : 
 enum 
 , 
 "candidateSubnets" 
 : 
 [ 
 string 
 ] 
 , 
 "bandwidth" 
 : 
 enum 
 , 
 "partnerMetadata" 
 : 
 { 
 "partnerName" 
 : 
 string 
 , 
 "interconnectName" 
 : 
 string 
 , 
 "portalUrl" 
 : 
 string 
 } 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "labelFingerprint" 
 : 
 string 
 , 
 "state" 
 : 
 enum 
 , 
 "partnerAsn" 
 : 
 string 
 , 
 "encryption" 
 : 
 enum 
 , 
 "ipsecInternalAddresses" 
 : 
 [ 
 string 
 ] 
 , 
 "dataplaneVersion" 
 : 
 integer 
 , 
 "satisfiesPzs" 
 : 
 boolean 
 , 
 "stackType" 
 : 
 enum 
 , 
 "cloudRouterIpv6Address" 
 : 
 string 
 , 
 "customerRouterIpv6Address" 
 : 
 string 
 , 
 "candidateIpv6Subnets" 
 : 
 [ 
 string 
 ] 
 , 
 "cloudRouterIpv6InterfaceId" 
 : 
 string 
 , 
 "customerRouterIpv6InterfaceId" 
 : 
 string 
 , 
 "subnetLength" 
 : 
 integer 
 , 
 "remoteService" 
 : 
 string 
 , 
 "configurationConstraints" 
 : 
 { 
 "bgpMd5" 
 : 
 enum 
 , 
 "bgpPeerAsnRanges" 
 : 
 [ 
 { 
 "min" 
 : 
 integer 
 , 
 "max" 
 : 
 integer 
 } 
 ] 
 } 
 , 
 "attachmentGroup" 
 : 
 string 
 , 
 "l2Forwarding" 
 : 
 { 
 "applianceMappings" 
 : 
 { 
 string 
 : 
 { 
 "name" 
 : 
 string 
 , 
 "applianceIpAddress" 
 : 
 string 
 , 
 "innerVlanToApplianceMappings" 
 : 
 [ 
 { 
 "innerVlanTags" 
 : 
 [ 
 string 
 ] 
 , 
 "innerApplianceIpAddress" 
 : 
 string 
 } 
 ] 
 } 
 , 
 ... 
 } 
 , 
 "network" 
 : 
 string 
 , 
 "geneveHeader" 
 : 
 { 
 "vni" 
 : 
 integer 
 } 
 , 
 "defaultApplianceIpAddress" 
 : 
 string 
 , 
 "tunnelEndpointIpAddress" 
 : 
 string 
 } 
 , 
 "candidateCloudRouterIpAddress" 
 : 
 string 
 , 
 "candidateCustomerRouterIpAddress" 
 : 
 string 
 , 
 "candidateCloudRouterIpv6Address" 
 : 
 string 
 , 
 "candidateCustomerRouterIpv6Address" 
 : 
 string 
 , 
 "params" 
 : 
 { 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.

    description

    string

    An optional description of this 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.

    interconnect

    string

    URL of the underlying Interconnect object that this attachment's traffic will traverse through.

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

    • resourcemanager.projects.get
    router

    string

    URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

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

    • resourcemanager.projects.get
    region

    string

    [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    googleReferenceId
    (deprecated)

    string

    [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.

    mtu

    integer

    Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.

    privateInterconnectInfo

    object

    [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

    privateInterconnectInfo.tag8021q

    integer

    [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.

    operationalStatus

    enum

    [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:

    • OS_ACTIVE: The attachment has been turned up and is ready to use.
    • OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
    cloudRouterIpAddress

    string

    [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

    customerRouterIpAddress

    string

    [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

    type

    enum

    The type of interconnect attachment this is, which can take one of the following values:

    • DEDICATED: an attachment to a Dedicated Interconnect.
    • PARTNER: an attachment to a Partner Interconnect, created by the customer.
    • PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
  • L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
    • pairingKey

    string

    [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

    adminEnabled

    boolean

    Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

    vlanTag8021q

    integer

    The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

    edgeAvailabilityDomain

    enum

    Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

    • AVAILABILITY_DOMAIN_ANY
    • AVAILABILITY_DOMAIN_1
    • AVAILABILITY_DOMAIN_2
    For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
    candidateSubnets[]

    string

    Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

    bandwidth

    enum

    Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:

    • BPS_50M: 50 Mbit/s
    • BPS_100M: 100 Mbit/s
    • BPS_200M: 200 Mbit/s
    • BPS_300M: 300 Mbit/s
    • BPS_400M: 400 Mbit/s
    • BPS_500M: 500 Mbit/s
    • BPS_1G: 1 Gbit/s
    • BPS_2G: 2 Gbit/s
    • BPS_5G: 5 Gbit/s
    • BPS_10G: 10 Gbit/s
    • BPS_20G: 20 Gbit/s
    • BPS_50G: 50 Gbit/s
    • BPS_100G: 100 Gbit/s
    partnerMetadata

    object

    Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

    partnerMetadata.partnerName

    string

    Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.

    partnerMetadata.interconnectName

    string

    Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.

    partnerMetadata.portalUrl

    string

    URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.

    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.interconnectAttachments.setLabels
    labelFingerprint

    string ( bytes format)

    A fingerprint for the labels being applied to this InterconnectAttachment, 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 InterconnectAttachment.

    A base64-encoded string.

    state

    enum

    [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:

    • ACTIVE: The attachment has been turned up and is ready to use.
    • UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
    • PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
    • PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
    • PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
    • DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
    partnerAsn

    string ( int64 format)

    Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

    encryption

    enum

    Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are:

    • NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment.
    • IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use HA VPN over Cloud Interconnect , the VLAN attachment must be created with this option.
    ipsecInternalAddresses[]

    string

    A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.

    dataplaneVersion

    integer

    [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.

    satisfiesPzs

    boolean

    [Output Only] Reserved for future use.

    stackType

    enum

    The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

    This field can be both set at interconnect attachments creation and update interconnect attachment operations.

    cloudRouterIpv6Address

    string

    [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

    customerRouterIpv6Address

    string

    [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

    candidateIpv6Subnets[]

    string

    This field is not available.

    cloudRouterIpv6InterfaceId

    string

    This field is not available.

    customerRouterIpv6InterfaceId

    string

    This field is not available.

    subnetLength

    integer

    Input only. Length of the IPv4 subnet mask. Allowed values:

    • 29 (default)
    • 30

    The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error.

    Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.

    remoteService

    string

    [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure".

    The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.

    configurationConstraints

    object

    [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

    configurationConstraints.bgpMd5

    enum

    [Output Only] Whether the attachment's BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.

    For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachmentConfigurationConstraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.

    configurationConstraints.bgpPeerAsnRanges[]

    object

    [Output Only] interconnectAttachments.list of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534.

    This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.

    configurationConstraints.bgpPeerAsnRanges[].min

    integer ( uint32 format)

    configurationConstraints.bgpPeerAsnRanges[].max

    integer ( uint32 format)

    attachmentGroup

    string

    [Output Only] URL of the AttachmentGroup that includes this Attachment.

    l2Forwarding

    object

    L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED.

    The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance.

    l2Forwarding.applianceMappings[]

    map (key: string, value: object)

    Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used.

    Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected.

    The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100.

    l2Forwarding.applianceMappings[].name

    string

    Optional. The name of this appliance mapping rule.

    l2Forwarding.applianceMappings[].applianceIpAddress

    string

    Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag.

    Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used.

    l2Forwarding.applianceMappings[].innerVlanToApplianceMappings[]

    object

    Optional. Used to match against the inner VLAN when the packet contains two VLAN tags.

    A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used.

    l2Forwarding.applianceMappings[].innerVlanToApplianceMappings[].innerVlanTags[]

    string

    Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected.

    The inner VLAN tags must have an ethertype value of 0x8100.

    l2Forwarding.applianceMappings[].innerVlanToApplianceMappings[].innerApplianceIpAddress

    string

    Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags.

    l2Forwarding.network

    string

    Required. Resource URL of the network to which this attachment belongs.

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

    • compute.networks.use
    l2Forwarding.geneveHeader

    object

    Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926 . It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments.

    l2Forwarding.geneveHeader.vni

    integer ( uint32 format)

    Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215.

    l2Forwarding.defaultApplianceIpAddress

    string

    Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found.

    Unset field (null-value) indicates the unmatched packet should be dropped.

    l2Forwarding.tunnelEndpointIpAddress

    string

    Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment.

    candidateCloudRouterIpAddress

    string

    Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidateCloudRouterIpAddress and candidateCustomerRouterIpAddress fields must be set or both must be unset.
    • Prefix length of both candidateCloudRouterIpAddress and candidateCustomerRouterIpAddress must be the same.
    • Max prefix length is 31.
    candidateCustomerRouterIpAddress

    string

    Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.

    candidateCloudRouterIpv6Address

    string

    Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidateCloudRouterIpv6Address and candidateCustomerRouterIpv6Address fields must be set or both must be unset.
    • Prefix length of both candidateCloudRouterIpv6Address and candidateCustomerRouterIpv6Address must be the same.
    • Max prefix length is 126.
    candidateCustomerRouterIpv6Address

    string

    Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.

    params

    object

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

    params.resourceManagerTags

    map (key: string, value: string)

    Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags . The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid. * Inconsistent format is not supported. For instance: {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.

    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 regular expression of [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.interconnectAttachments.create

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: