project STRING Required

Project ID for this request

region STRING Required

Name of the region scoping this request

autoscaler STRING Required

Name of the autoscaler to return

autoscalingPolicy OBJECT

Cloud Autoscaler policy

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

autoscalingPolicy.cpuUtilization OBJECT

CPU utilization policy

autoscalingPolicy.cpuUtilization.utilizationTarget NUMBER

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

autoscalingPolicy.customMetricUtilizations[] OBJECT

Custom utilization metric policy

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

autoscalingPolicy.customMetricUtilizations[].utilizationTarget NUMBER

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 utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances

autoscalingPolicy.customMetricUtilizations[].utilizationTargetType ENUMERATION

Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE

autoscalingPolicy.loadBalancingUtilization OBJECT

Configuration parameters of autoscaling based on load balancing

autoscalingPolicy.loadBalancingUtilization.utilizationTarget NUMBER

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

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

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

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

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

id INTEGER

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

kind STRING

[Output Only] Type of the resource. Always compute#autoscaler for 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

region STRING

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

selfLink STRING

[Output Only] Server-defined URL for the resource

status ENUMERATION

[Output Only] The status of the autoscaler configuration

statusDetails[] OBJECT

statusDetails[].message STRING

The status message

statusDetails[].type ENUMERATION

The type of error returned

target STRING

URL of the managed instance group that this autoscaler will scale

zone STRING

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