Method: interconnectAttachments.aggregatedList

Retrieves an aggregated list of interconnect attachments.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/interconnectAttachments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
includeAllScopes

boolean

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber

string (int64 format)

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "interconnectAttachments": [
        {
          "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
              }
            ]
          }
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    },
    ...
  },
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "unreachables": [
    string
  ]
}
Fields
kind

string

[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items

map (key: string, value: object)

A list of InterconnectAttachmentsScopedList resources.

Key: Name of the scope containing this set of interconnect attachments.
items.interconnectAttachments[]

object

A list of interconnect attachments contained in this scope.
items.interconnectAttachments[].kind

string

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

string

An optional description of this resource.
items.interconnectAttachments[].selfLink

string

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

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
items.interconnectAttachments[].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.
items.interconnectAttachments[].interconnect

string

URL of the underlying Interconnect object that this attachment's traffic will traverse through.
items.interconnectAttachments[].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.
items.interconnectAttachments[].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.
items.interconnectAttachments[].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.
items.interconnectAttachments[].mtu

integer

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
items.interconnectAttachments[].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.
items.interconnectAttachments[].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.
items.interconnectAttachments[].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.
items.interconnectAttachments[].cloudRouterIpAddress

string

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

string

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
items.interconnectAttachments[].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.
items.interconnectAttachments[].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"
items.interconnectAttachments[].adminEnabled

boolean

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
items.interconnectAttachments[].vlanTag8021q

integer

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

enum

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.
items.interconnectAttachments[].candidateSubnets[]

string

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.
items.interconnectAttachments[].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

    		•
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].partnerMetadata.partnerName

    string

    Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].satisfiesPzs

    boolean

    [Output Only] Reserved for future use.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].cloudRouterIpv6Address

    string

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

    string

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

    string

    This field is not available.
    items.interconnectAttachments[].cloudRouterIpv6InterfaceId

    string

    This field is not available.
    items.interconnectAttachments[].customerRouterIpv6InterfaceId

    string

    This field is not available.
    items.interconnectAttachments[].subnetLength

    integer

    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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].configurationConstraints

    object

    [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].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.
    items.interconnectAttachments[].configurationConstraints.bgpPeerAsnRanges[].min

    integer (uint32 format)
    items.interconnectAttachments[].configurationConstraints.bgpPeerAsnRanges[].max

    integer (uint32 format)
    items.warning

    object

    Informational warning which replaces the list of addresses when the list is empty.
    items.warning.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.
    items.warning.message

    string

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

    object

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

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    items.warning.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).
    items.warning.data[].value

    string

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

    string

    [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
    warning

    object

    [Output Only] Informational warning message.
    warning.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.
    warning.message

    string

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

    object

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

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    warning.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).
    warning.data[].value

    string

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

    string

    [Output Only] Unreachable resources.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/compute.readonly
    • 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.list

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