Autoscalers: aggregatedList

Requires authorization

Retrieves an aggregated list of autoscalers.


HTTP request



Parameter name Value Description
Path parameters
project string Project ID for 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.


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


Request body

Do not supply a request body with this method.


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

  "kind": "compute#autoscalerAggregatedList",
  "id": string,
  "items": {
    (key): {
      "autoscalers": [
          "kind": "compute#autoscaler",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "target": string,
          "autoscalingPolicy": {
            "minNumReplicas": integer,
            "maxNumReplicas": integer,
            "coolDownPeriodSec": integer,
            "cpuUtilization": {
              "utilizationTarget": double
            "customMetricUtilizations": [
                "metric": string,
                "utilizationTarget": double,
                "utilizationTargetType": string
            "loadBalancingUtilization": {
              "utilizationTarget": double
          "zone": string,
          "region": string,
          "selfLink": string,
          "status": string,
          "statusDetails": [
              "message": string,
              "type": string
      "warning": {
        "code": string,
        "message": string,
        "data": [
            "key": string,
            "value": string
  "nextPageToken": string,
  "selfLink": string
Property name Value Description Notes
kind string [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
id string [Output Only] The unique identifier for the resource. This identifier is defined by the server.
items object A map of scoped autoscaler lists.
items.(key) nested object [Output Only] Name of the scope containing this set of autoscalers.
items.(key).autoscalers[] list [Output Only] List of autoscalers contained in this scope.
items.(key).warning object [Output Only] Informational warning which replaces the list of autoscalers 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)[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.(key)[].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)[].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.
items.(key).autoscalers[].kind string [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
items.(key).autoscalers[].id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.

items.(key).autoscalers[].creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
items.(key).autoscalers[].zone string [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
items.(key).autoscalers[].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).autoscalers[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).autoscalers[].target string URL of the managed instance group that this autoscaler will scale.
items.(key).autoscalers[].autoscalingPolicy nested object The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.

If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
items.(key).autoscalers[].autoscalingPolicy.minNumReplicas integer The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
items.(key).autoscalers[].autoscalingPolicy.maxNumReplicas integer The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
items.(key).autoscalers[].autoscalingPolicy.coolDownPeriodSec integer The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
items.(key).autoscalers[].autoscalingPolicy.cpuUtilization nested object Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
items.(key).autoscalers[].autoscalingPolicy.cpuUtilization.utilizationTarget double The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.

If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.

If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
items.(key).autoscalers[].autoscalingPolicy.customMetricUtilizations[] list Configuration parameters of autoscaling based on a custom metric.
items.(key).autoscalers[].autoscalingPolicy.customMetricUtilizations[].metric string The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.

For example, the following is a valid metric:
The following is not a valid metric because it does not increase or decrease based on usage:
items.(key).autoscalers[].autoscalingPolicy.customMetricUtilizations[].utilizationTarget double Target value of the metric which autoscaler should maintain. Must be a positive value.
items.(key).autoscalers[].autoscalingPolicy.customMetricUtilizations[].utilizationTargetType string Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
items.(key).autoscalers[].autoscalingPolicy.loadBalancingUtilization nested object Configuration parameters of autoscaling based on load balancer.
items.(key).autoscalers[].autoscalingPolicy.loadBalancingUtilization.utilizationTarget double Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
items.(key).autoscalers[].region string [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
items.(key).autoscalers[].status string [Output Only] The status of the autoscaler configuration.
items.(key).autoscalers[].statusDetails[] list [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
items.(key).autoscalers[].statusDetails[].message string The status message.
items.(key).autoscalers[].statusDetails[].type string The type of error returned.

Send feedback about...

Compute Engine