Skip to main content

autoscalers

Overview

Nameautoscalers
TypeResource
Idgoogle.compute.autoscalers

Fields

NameDatatypeDescription
idstring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName 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.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
autoscalingPolicyobjectCloud Autoscaler policy.
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
targetstringURL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
recommendedSizeinteger[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.
regionstring[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
statusDetailsarray[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.
zonestring[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
selfLinkstring[Output Only] Server-defined URL for the resource.
scalingScheduleStatusobject[Output Only] Status information of existing scaling schedules.
kindstring[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
statusstring[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 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.

Methods

NameAccessible byRequired ParamsDescription
aggregated_listSELECTprojectRetrieves an aggregated list of autoscalers.
getSELECTautoscaler, project, zoneReturns the specified autoscaler resource.
listSELECTproject, zoneRetrieves a list of autoscalers contained within the specified zone.
insertINSERTproject, zoneCreates an autoscaler in the specified project using the data included in the request.
deleteDELETEautoscaler, project, zoneDeletes the specified autoscaler.
_aggregated_listEXECprojectRetrieves an aggregated list of autoscalers.
patchEXECproject, zoneUpdates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
updateEXECproject, zoneUpdates an autoscaler in the specified project using the data included in the request.