Method: autoscalers.get

Returns the specified autoscaler resource. acceleratorTypes.get a list of available autoscalers by making a list() request.

HTTP request


The URL uses Google API HTTP annotation syntax.

Path parameters



Project ID for this request.



Name of the zone for this request.



Name of the autoscaler to return.

Authorization requires the following Google IAM permission on the specified resource resource_id:

  • compute.autoscalers.get

Request body

The request body must be empty.

Response body

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

JSON representation
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "target": string,
    "autoscalingPolicy": {
      "minNumReplicas": number,
      "maxNumReplicas": number,
      "coolDownPeriodSec": number,
      "cpuUtilization": {
        "utilizationTarget": number
      "customMetricUtilizations": [
          "metric": string,
          "filter": string,
          "utilizationTarget": number,
          "singleInstanceAssignment": number,
          "utilizationTargetType": enum
      "loadBalancingUtilization": {
        "utilizationTarget": number
    "zone": string,
    "region": string,
    "selfLink": string,
    "status": enum,
    "statusDetails": {
      "message": string,
      "type": enum
    "kind": string


string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.



[Output Only] Creation timestamp in RFC3339 text format.


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.



An optional description of this resource. Provide this property when you create the resource.


URL of the managed instance group that this autoscaler will scale.



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%.



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.



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.



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.



Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.



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.



Configuration parameters of autoscaling based on a custom metric.



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.



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.

You should 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.



The target value of the metric that autoscaler should maintain. 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 The autoscaler will work to keep this value constant for each of the instances.



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 will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing.

A good metric to use with the target is for example 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.



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.



Configuration parameters of autoscaling based on load balancer.



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.


[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).



[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).



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



[Output Only] The status of the autoscaler configuration.



[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.



The status message.



The type of error returned.



[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Auth Guide.

Send feedback about...

Compute Engine