- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Retrieves a list of autoscalers contained within the specified zone.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
Name of the zone for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
|
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "target": string, "autoscalingPolicy": { "minNumReplicas": integer, "maxNumReplicas": integer, "scaleInControl": { "maxScaledInReplicas": { "fixed": integer, "percent": integer, "calculated": integer }, "timeWindowSec": integer }, "coolDownPeriodSec": integer, "cpuUtilization": { "utilizationTarget": number }, "customMetricUtilizations": [ { "metric": string, "filter": string, "utilizationTarget": number, "singleInstanceAssignment": number, "utilizationTargetType": enum } ], "loadBalancingUtilization": { "utilizationTarget": number }, "mode": enum }, "zone": string, "region": string, "selfLink": string, "status": enum, "statusDetails": [ { "message": string, "type": enum } ], "recommendedSize": integer, "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of Autoscaler resources. |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name |
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 |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].target |
URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. |
items[].autoscalingPolicy |
The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: If none of these are specified, the default will be to autoscale based on |
items[].autoscalingPolicy.minNumReplicas |
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[].autoscalingPolicy.maxNumReplicas |
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[].autoscalingPolicy.scaleInControl |
|
items[].autoscalingPolicy.scaleInControl.maxScaledInReplicas |
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[].autoscalingPolicy.scaleInControl.maxScaledInReplicas.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
items[].autoscalingPolicy.scaleInControl.maxScaledInReplicas.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
items[].autoscalingPolicy.scaleInControl.maxScaledInReplicas.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
items[].autoscalingPolicy.scaleInControl.timeWindowSec |
How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above. |
items[].autoscalingPolicy.coolDownPeriodSec |
The number of seconds that the autoscaler waits 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[].autoscalingPolicy.cpuUtilization |
Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. |
items[].autoscalingPolicy.cpuUtilization.utilizationTarget |
The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is 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[].autoscalingPolicy.customMetricUtilizations[] |
Configuration parameters of autoscaling based on a custom metric. |
items[].autoscalingPolicy.customMetricUtilizations[].metric |
The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of |
items[].autoscalingPolicy.customMetricUtilizations[].filter |
A filter string, compatible with a Stackdriver Monitoring filter string for For the filter to be valid for autoscaling purposes, the following rules apply:
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 |
items[].autoscalingPolicy.customMetricUtilizations[].utilizationTarget |
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 |
items[].autoscalingPolicy.customMetricUtilizations[].singleInstanceAssignment |
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 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[].autoscalingPolicy.customMetricUtilizations[].utilizationTargetType |
Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either |
items[].autoscalingPolicy.loadBalancingUtilization |
Configuration parameters of autoscaling based on load balancer. |
items[].autoscalingPolicy.loadBalancingUtilization.utilizationTarget |
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 |
items[].autoscalingPolicy.mode |
Defines operating mode for this policy. |
items[].zone |
[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). |
items[].region |
[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). |
items[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].status |
[Output Only] The status of the autoscaler configuration. Current set of possible values:
|
items[].statusDetails[] |
[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[].statusDetails[].message |
The status message. |
items[].statusDetails[].type |
The type of error, warning, or notice returned. Current set of possible values:
|
items[].recommendedSize |
[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[].kind |
[Output Only] Type of the resource. Always |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
kind |
[Output Only] Type of resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
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