Method: autoscalers.aggregatedList

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
  • JSON representation
    • JSON representation
      • JSON representation
      • JSON representation
      • JSON representation
      • JSON representation
      • JSON representation
    • JSON representation
    • JSON representation
• Authorization scopes
• IAM Permissions
• Try it!

Retrieves an aggregated list of autoscalers.

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/autoscalers

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: { "autoscalers": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "target": string, "autoscalingPolicy": { "minNumReplicas": integer, "maxNumReplicas": integer, "scaleDownControl": { "maxScaledDownReplicas": { "fixed": integer, "percent": integer, "calculated": integer }, "timeWindowSec": integer }, "scaleInControl": { "maxScaledInReplicas": { "fixed": integer, "percent": integer, "calculated": integer }, "timeWindowSec": integer }, "coolDownPeriodSec": integer, "cpuUtilization": { "utilizationTarget": number, "predictiveMethod": enum }, "customMetricUtilizations": [ { "metric": string, "filter": string, "utilizationTargetType": enum, "utilizationTarget": number, "singleInstanceAssignment": number } ], "loadBalancingUtilization": { "utilizationTarget": number }, "mode": enum, "scalingSchedules": { string: { "minRequiredReplicas": integer, "schedule": string, "timeZone": string, "durationSec": integer, "disabled": boolean, "description": string }, ... } }, "zone": string, "region": string, "selfLink": string, "status": enum, "statusDetails": [ { "message": string, "type": enum } ], "recommendedSize": integer, "scalingScheduleStatus": { string: { "nextStartTime": string, "lastStartTime": string, "state": enum }, ... } } ], "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#autoscalerAggregatedList for aggregated lists of autoscalers.
id	string [Output Only] Unique identifier for the resource; defined by the server.
items	map (key: string, value: object) A list of AutoscalersScopedList resources. Key: [Output Only] Name of the scope containing this set of autoscalers.
items.autoscalers[]	object [Output Only] A list of autoscalers contained in this scope.
items.autoscalers[].kind	string [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
items.autoscalers[].id	string (uint64 format) [Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.autoscalers[].creationTimestamp	string [Output Only] Creation timestamp in RFC3339 text format.
items.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.autoscalers[].description	string An optional description of this resource. Provide this property when you create the resource.
items.autoscalers[].target	string URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
items.autoscalers[].autoscalingPolicy	object The configuration parameters for the autoscaling algorithm. You can define one or more signals 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.autoscalers[].autoscalingPolicy.minNumReplicas	integer The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.
items.autoscalers[].autoscalingPolicy.maxNumReplicas	integer The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.
items.autoscalers[].autoscalingPolicy.scaleDownControl	object
items.autoscalers[].autoscalingPolicy.scaleDownControl.maxScaledDownReplicas	object Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.
items.autoscalers[].autoscalingPolicy.scaleDownControl.maxScaledDownReplicas.fixed	integer Specifies a fixed number of VM instances. This must be a positive integer.
items.autoscalers[].autoscalingPolicy.scaleDownControl.maxScaledDownReplicas.percent	integer Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
items.autoscalers[].autoscalingPolicy.scaleDownControl.maxScaledDownReplicas.calculated	integer [Output Only] Absolute value of VM instances calculated based on the specific mode. If the value is fixed, then the calculated value is equal to the fixed value. If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
items.autoscalers[].autoscalingPolicy.scaleDownControl.timeWindowSec	integer How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.
items.autoscalers[].autoscalingPolicy.scaleInControl	object
items.autoscalers[].autoscalingPolicy.scaleInControl.maxScaledInReplicas	object Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.
items.autoscalers[].autoscalingPolicy.scaleInControl.maxScaledInReplicas.fixed	integer Specifies a fixed number of VM instances. This must be a positive integer.
items.autoscalers[].autoscalingPolicy.scaleInControl.maxScaledInReplicas.percent	integer Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
items.autoscalers[].autoscalingPolicy.scaleInControl.maxScaledInReplicas.calculated	integer [Output Only] Absolute value of VM instances calculated based on the specific mode. If the value is fixed, then the calculated value is equal to the fixed value. If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
items.autoscalers[].autoscalingPolicy.scaleInControl.timeWindowSec	integer How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.
items.autoscalers[].autoscalingPolicy.coolDownPeriodSec	integer The number of seconds that your application takes to initialize on a VM instance. This is referred to as the initialization period. Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.
items.autoscalers[].autoscalingPolicy.cpuUtilization	object Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
items.autoscalers[].autoscalingPolicy.cpuUtilization.utilizationTarget	number The target CPU utilization that the autoscaler maintains. 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 in 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 out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
items.autoscalers[].autoscalingPolicy.cpuUtilization.predictiveMethod	enum Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.
items.autoscalers[].autoscalingPolicy.customMetricUtilizations[]	object Configuration parameters of autoscaling based on a custom metric.
items.autoscalers[].autoscalingPolicy.customMetricUtilizations[].utilizationTarget	number The target value of the metric that autoscaler maintains. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilizationTarget is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. The autoscaler works to keep this value constant for each of the instances.
items.autoscalers[].autoscalingPolicy.customMetricUtilizations[].singleInstanceAssignment	number If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilizationTarget instead.
items.autoscalers[].autoscalingPolicy.customMetricUtilizations[].metric	string The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.
items.autoscalers[].autoscalingPolicy.customMetricUtilizations[].filter	string A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: You can only use the AND operator for joining selectors. You can only use direct equality comparison operator (=) without any functions for each selector. You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. Try to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.
items.autoscalers[].autoscalingPolicy.customMetricUtilizations[].utilizationTargetType	enum Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.
items.autoscalers[].autoscalingPolicy.loadBalancingUtilization	object Configuration parameters of autoscaling based on load balancer.
items.autoscalers[].autoscalingPolicy.loadBalancingUtilization.utilizationTarget	number Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8.
items.autoscalers[].autoscalingPolicy.mode	enum Defines the operating mode for this policy. The following modes are available: OFF: Disables the autoscaler but maintains its configuration. ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler"
items.autoscalers[].autoscalingPolicy.scalingSchedules[]	map (key: string, value: object) Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest minRequiredReplicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.
items.autoscalers[].autoscalingPolicy.scalingSchedules[].minRequiredReplicas	integer The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.
items.autoscalers[].autoscalingPolicy.scalingSchedules[].schedule	string The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to timeZone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.
items.autoscalers[].autoscalingPolicy.scalingSchedules[].timeZone	string The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty.
items.autoscalers[].autoscalingPolicy.scalingSchedules[].durationSec	integer The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.
items.autoscalers[].autoscalingPolicy.scalingSchedules[].disabled	boolean A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.
items.autoscalers[].autoscalingPolicy.scalingSchedules[].description	string A description of a scaling schedule.
items.autoscalers[].zone	string [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
items.autoscalers[].region	string [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
items.autoscalers[].selfLink	string [Output Only] Server-defined URL for the resource.
items.autoscalers[].status	enum [Output Only] The status of the autoscaler configuration. Current set of possible values: PENDING: Autoscaler backend hasn't read new/updated configuration. DELETING: Configuration is being deleted. ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
items.autoscalers[].statusDetails[]	object [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.autoscalers[].statusDetails[].message	string The status message.
items.autoscalers[].statusDetails[].type	enum The type of error, warning, or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only out" mode. The autoscaler can add instances but not remove any. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.
items.autoscalers[].recommendedSize	integer [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.
items.autoscalers[].scalingScheduleStatus[]	map (key: string, value: object) [Output Only] Status information of existing scaling schedules.
items.autoscalers[].scalingScheduleStatus[].nextStartTime	string [Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.
items.autoscalers[].scalingScheduleStatus[].lastStartTime	string [Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format.
items.autoscalers[].scalingScheduleStatus[].state	enum [Output Only] The current state of a scaling schedule.
items.warning	object [Output Only] Informational warning which replaces the list of autoscalers 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.
selfLink	string [Output Only] Server-defined URL for this resource.
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. end_interface: MixerListResponseWithEtagBuilder

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.autoscalers.list

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