Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
regionAutoscalers

Updates an autoscaler in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

patch/projects/{project}/regions/{region}/autoscalers

Path parameters

projectstring required

Project ID for this request.

regionstring required

Name of the region scoping this request.

Query parameters

autoscalerstring

Name of the autoscaler to patch.

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

status'ACTIVE' | 'DELETING' | 'ERROR' | 'PENDING'

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

scalingScheduleStatusobject

Output only. [Output Only] Status information of existing scaling schedules.

idstring uint64

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

zonestring

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

recommendedSizeinteger

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

selfLinkstring

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

targetstring

URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.

descriptionstring

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

regionstring

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

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

kindstring

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

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

Response

Successful response