BackendServices: aggregatedList

Requires authorization

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

Request

HTTP request

GET https://www.googleapis.com/compute/beta/projects/project/aggregated/backendServices

Parameters

Parameter name Value Description
Path parameters
project string Name of the project scoping this request.
Optional query parameters
filter string Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResults unsigned integer 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)
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.
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.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#backendServiceAggregatedList",
  "id": string,
  "items": {
    (key): {
      "backendServices": [
        {
          "kind": "compute#backendService",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "selfLink": string,
          "backends": [
            {
              "description": string,
              "group": string,
              "balancingMode": string,
              "maxUtilization": float,
              "maxRate": integer,
              "maxRatePerInstance": float,
              "maxConnections": integer,
              "maxConnectionsPerInstance": integer,
              "capacityScaler": float
            }
          ],
          "healthChecks": [
            string
          ],
          "timeoutSec": integer,
          "port": integer,
          "protocol": string,
          "fingerprint": bytes,
          "portName": string,
          "enableCDN": boolean,
          "sessionAffinity": string,
          "affinityCookieTtlSec": integer,
          "region": string,
          "loadBalancingScheme": string,
          "connectionDraining": {
            "drainingTimeoutSec": integer
          },
          "iap": {
            "enabled": boolean,
            "oauth2ClientId": string,
            "oauth2ClientSecret": string,
            "oauth2ClientSecretSha256": string
          },
          "cdnPolicy": {
            "cacheKeyPolicy": {
              "includeProtocol": boolean,
              "includeHost": boolean,
              "includeQueryString": boolean,
              "queryStringWhitelist": [
                string
              ],
              "queryStringBlacklist": [
                string
              ]
            }
          }
        }
      ],
      "warning": {
        "code": string,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    }
  },
  "nextPageToken": string,
  "selfLink": string
}
Property name Value Description Notes
kind string Type of resource.
id string [Output Only] Unique identifier for the resource; defined by the server.
items object A map of scoped BackendService lists.
items.(key) nested object Name of the scope containing this set of BackendServices.
items.(key).backendServices[] list List of BackendServices contained in this scope.
items.(key).backendServices[].kind string [Output Only] Type of resource. Always compute#backendService for backend services.
items.(key).backendServices[].id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.(key).backendServices[].creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
items.(key).backendServices[].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.(key).backendServices[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).backendServices[].backends[] list The list of backends that serve this BackendService.
items.(key).backendServices[].backends[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).backendServices[].backends[].group string The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.

Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.

When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
items.(key).backendServices[].backends[].balancingMode string Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

This cannot be used for internal load balancing.
items.(key).backendServices[].backends[].maxUtilization float Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].

This cannot be used for internal load balancing.
items.(key).backendServices[].backends[].maxRate integer The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.
items.(key).backendServices[].backends[].maxRatePerInstance float The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.
items.(key).backendServices[].backends[].maxConnections integer The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.
items.(key).backendServices[].backends[].maxConnectionsPerInstance integer The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.
items.(key).backendServices[].backends[].capacityScaler float A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

This cannot be used for internal load balancing.
items.(key).backendServices[].healthChecks[] list The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.

For internal load balancing, a URL to a HealthCheck resource must be specified instead.
items.(key).backendServices[].timeoutSec integer How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
items.(key).backendServices[].port integer Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

This cannot be used for internal load balancing.
items.(key).backendServices[].protocol string The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.

For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
items.(key).backendServices[].fingerprint bytes 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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
items.(key).backendServices[].portName string Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

When the load balancing scheme is INTERNAL, this field is not used.
items.(key).backendServices[].enableCDN boolean If true, enable Cloud CDN for this BackendService.

When the load balancing scheme is INTERNAL, this field is not used.
items.(key).backendServices[].sessionAffinity string Type of session affinity to use. The default is NONE.

When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.

When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the protocol is UDP, this field is not used.
items.(key).backendServices[].affinityCookieTtlSec integer Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.

When the load balancing scheme is INTERNAL, this field is not used.
items.(key).backendServices[].region string [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
items.(key).backendServices[].loadBalancingScheme string
items.(key).backendServices[].connectionDraining nested object
items.(key).backendServices[].connectionDraining.drainingTimeoutSec integer Time for which instance will be drained (not accept new connections, but still work to finish started).
items.(key).warning object Informational warning which replaces the list of backend services when the list is empty.
items.(key).warning.code string [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.(key).warning.message string [Output Only] A human-readable description of the warning code.
items.(key).warning.data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.(key).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.(key).warning.data[].value string [Output Only] A warning data value corresponding to the key.
nextPageToken string [Output Only] A token used to continue a truncated list request.
items.(key).backendServices[].iap nested object
items.(key).backendServices[].iap.enabled boolean
items.(key).backendServices[].iap.oauth2ClientId string
items.(key).backendServices[].iap.oauth2ClientSecret string
items.(key).backendServices[].iap.oauth2ClientSecretSha256 string
items.(key).backendServices[].cdnPolicy nested object Cloud CDN configuration for this BackendService.
items.(key).backendServices[].cdnPolicy.cacheKeyPolicy nested object The CacheKeyPolicy for this CdnPolicy.
items.(key).backendServices[].cdnPolicy.cacheKeyPolicy.includeProtocol boolean If true, http and https requests will be cached separately.
items.(key).backendServices[].cdnPolicy.cacheKeyPolicy.includeHost boolean If true, requests to different hosts will be cached separately.
items.(key).backendServices[].cdnPolicy.cacheKeyPolicy.includeQueryString boolean If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
items.(key).backendServices[].cdnPolicy.cacheKeyPolicy.queryStringWhitelist[] list Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
items.(key).backendServices[].cdnPolicy.cacheKeyPolicy.queryStringBlacklist[] list Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine