Method: autoscalers.get

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

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

Name of the zone for this request.

resourceId

string

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,
          "utilizationTarget": number,
          "utilizationTargetType": enum
        }
      ],
      "loadBalancingUtilization": {
        "utilizationTarget": number
      }
    },
    "zone": string,
    "region": string,
    "selfLink": string,
    "status": enum,
    "statusDetails": {
      "message": string,
      "type": enum
    },
    "kind": string
  }
}
Fields
resource

object

resource.id

string (fixed64 format)

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

resource.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

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

resource.description

string

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

resource.target

string

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

resource.autoscalingPolicy

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

resource.autoscalingPolicy.minNumReplicas

number

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.

resource.autoscalingPolicy.maxNumReplicas

number

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.

resource.autoscalingPolicy.coolDownPeriodSec

number

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.

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

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

resource.autoscalingPolicy.customMetricUtilizations[]

object

Configuration parameters of autoscaling based on a custom metric.

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

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

resource.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. If not specified, the default is GAUGE.

resource.autoscalingPolicy.loadBalancingUtilization

object

Configuration parameters of autoscaling based on load balancer.

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

resource.zone

string

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

resource.region

string

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

resource.selfLink

string

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

resource.status

enum

[Output Only] The status of the autoscaler configuration.

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

resource.statusDetails[].message

string

The status message.

resource.statusDetails[].type

enum

The type of error returned.

resource.kind

string

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

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 Auth Guide.

Send feedback about...

Compute Engine