Method: autoscalers.get

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
    • JSON representation
    • JSON representation
    • JSON representation
• Authorization Scopes

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

HTTP request

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

The URL uses gRPC Transcoding 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 autoscaler: 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

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

Fields
id	string (fixed64 format) [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp	string [Output Only] Creation timestamp in RFC3339 text format.
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.
description	string An optional description of this resource. Provide this property when you create the resource.
target	string URL of the managed instance group that this autoscaler will scale.
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%.
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.
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.
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.
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.
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 Configuration parameters of autoscaling based on a custom metric.
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 utilizationTarget 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	enum 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 balancer.
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.
zone	string [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
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	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 or might not 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.
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.
statusDetails[].message	string The status message.
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 size bigger 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 up" mode. Instances in the group will be only added. 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): Exceeded quota for necessary resources, such as CPU, number of instances and so on. REGION_RESOURCE_STOCKOUT (ERROR): Showed 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.
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 Authentication Overview.