Method: serviceAttachments.aggregatedList

Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.

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

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/serviceAttachments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Name of the project scoping 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

Contains a list of ServiceAttachmentsScopedList.

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "serviceAttachments": [
        {
          "kind": string,
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "selfLink": string,
          "region": string,
          "producerForwardingRule": string,
          "targetService": string,
          "connectionPreference": enum,
          "connectedEndpoints": [
            {
              "status": enum,
              "pscConnectionId": string,
              "endpoint": string,
              "consumerNetwork": string,
              "propagatedConnectionCount": integer
            }
          ],
          "natSubnets": [
            string
          ],
          "enableProxyProtocol": boolean,
          "consumerRejectLists": [
            string
          ],
          "consumerAcceptLists": [
            {
              "projectIdOrNum": string,
              "networkUrl": string,
              "connectionLimit": integer
            }
          ],
          "pscServiceAttachmentId": {
            "high": string,
            "low": string
          },
          "fingerprint": string,
          "domainNames": [
            string
          ],
          "reconcileConnections": boolean,
          "propagatedConnectionLimit": 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

Type of resource.
id

string

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

map (key: string, value: object)

A list of ServiceAttachmentsScopedList resources.

Key: Name of the scope containing this set of ServiceAttachments.
items.serviceAttachments[]

object

A list of ServiceAttachments contained in this scope.
items.serviceAttachments[].kind

string

[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.
items.serviceAttachments[].id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.
items.serviceAttachments[].creationTimestamp

string

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

string

An optional description of this resource. Provide this property when you create the resource.
items.serviceAttachments[].selfLink

string

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

string

[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
items.serviceAttachments[].producerForwardingRule
(deprecated)

string

The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.
items.serviceAttachments[].targetService

string

The URL of a service serving the endpoint identified by this service attachment.
items.serviceAttachments[].connectionPreference

enum

The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.
items.serviceAttachments[].connectedEndpoints[]

object

[Output Only] An array of connections for all the consumers connected to this service attachment.
items.serviceAttachments[].connectedEndpoints[].status

enum

The status of a connected endpoint to this service attachment.
items.serviceAttachments[].connectedEndpoints[].pscConnectionId

string (uint64 format)

The PSC connection id of the connected endpoint.
items.serviceAttachments[].connectedEndpoints[].endpoint

string

The url of a connected endpoint.
items.serviceAttachments[].connectedEndpoints[].consumerNetwork

string

The url of the consumer network.
items.serviceAttachments[].connectedEndpoints[].propagatedConnectionCount

integer (uint32 format)

The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.
items.serviceAttachments[].natSubnets[]

string

An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.
items.serviceAttachments[].enableProxyProtocol

boolean

If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.
items.serviceAttachments[].consumerRejectLists[]

string

Specifies a list of projects or networks that are not allowed to connect to this service attachment. The project can be specified using its project ID or project number and the network can be specified using its URL. A given service attachment can manage connections at either the project or network level. Therefore, both the reject and accept lists for a given service attachment must contain either only projects or only networks.
items.serviceAttachments[].consumerAcceptLists[]

object

Specifies which consumer projects or networks are allowed to connect to the service attachment. Each project or network has a connection limit. A given service attachment can manage connections at either the project or network level. Therefore, both the accept and reject lists for a given service attachment must contain either only projects or only networks.
items.serviceAttachments[].consumerAcceptLists[].projectIdOrNum

string

The project id or number for the project to set the limit for.
items.serviceAttachments[].consumerAcceptLists[].networkUrl

string

The network URL for the network to set the limit for.
items.serviceAttachments[].consumerAcceptLists[].connectionLimit

integer (uint32 format)

The value of the limit to set.
items.serviceAttachments[].pscServiceAttachmentId

object

[Output Only] An 128-bit global unique ID of the PSC service attachment.
items.serviceAttachments[].pscServiceAttachmentId.high

string (uint64 format)
items.serviceAttachments[].pscServiceAttachmentId.low

string (uint64 format)
items.serviceAttachments[].fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

A base64-encoded string.
items.serviceAttachments[].domainNames[]

string

If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.
items.serviceAttachments[].reconcileConnections

boolean

This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints.

  • If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified .
  • If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list.
For newly created service attachment, this boolean defaults to false.
items.serviceAttachments[].propagatedConnectionLimit

integer (uint32 format)

The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer.

If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint.

If unspecified, the default propagated connection limit is 250.
items.warning

object

Informational warning which replaces the list of service attachments 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.serviceAttachments.list

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