- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates 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.
HTTP request
PATCH https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
Name of the zone for this request. |
Query parameters
Parameters | |
---|---|
requestId |
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 ( |
autoscaler |
Name of the autoscaler to patch. Authorization requires one or more of the following IAM permissions on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "target": string, "autoscalingPolicy": { "minNumReplicas": integer, "maxNumReplicas": integer, "scaleInControl": { "maxScaledInReplicas": { "fixed": integer, "percent": integer, "calculated": integer }, "timeWindowSec": integer }, "coolDownPeriodSec": integer, "cpuUtilization": { "utilizationTarget": number, "predictiveMethod": enum }, "customMetricUtilizations": [ { "metric": string, "filter": string, "utilizationTargetType": enum, "utilizationTarget": number, "singleInstanceAssignment": number } ], "loadBalancingUtilization": { "utilizationTarget": number }, "mode": enum, "scalingSchedules": { string: { "minRequiredReplicas": integer, "schedule": string, "timeZone": string, "durationSec": integer, "disabled": boolean, "description": string }, ... } }, "zone": string, "region": string, "selfLink": string, "status": enum, "statusDetails": [ { "message": string, "type": enum } ], "recommendedSize": integer, "scalingScheduleStatus": { string: { "nextStartTime": string, "lastStartTime": string, "state": enum }, ... } } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
target |
URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. Authorization requires the following IAM permission on the specified resource
|
autoscalingPolicy |
The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: If none of these are specified, the default will be to autoscale based on |
autoscalingPolicy.minNumReplicas |
The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed. |
autoscalingPolicy.maxNumReplicas |
The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas. |
autoscalingPolicy.scaleInControl |
|
autoscalingPolicy.scaleInControl.maxScaledInReplicas |
Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step. |
autoscalingPolicy.scaleInControl.maxScaledInReplicas.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
autoscalingPolicy.scaleInControl.maxScaledInReplicas.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
autoscalingPolicy.scaleInControl.maxScaledInReplicas.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
autoscalingPolicy.scaleInControl.timeWindowSec |
How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above. |
autoscalingPolicy.coolDownPeriodSec |
The number of seconds that your application takes to initialize on a VM instance. This is referred to as the initialization period. Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process. |
autoscalingPolicy.cpuUtilization |
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 |
The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is If the CPU level is below the target utilization, the autoscaler scales in 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 out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. |
autoscalingPolicy.cpuUtilization.predictiveMethod |
Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are:
|
autoscalingPolicy.customMetricUtilizations[] |
Configuration parameters of autoscaling based on a custom metric. |
autoscalingPolicy.customMetricUtilizations[].metric |
The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of |
autoscalingPolicy.customMetricUtilizations[].filter |
A filter string, compatible with a Stackdriver Monitoring filter string for For the filter to be valid for autoscaling purposes, the following rules apply:
Try to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using |
autoscalingPolicy.customMetricUtilizations[].utilizationTarget |
The target value of the metric that autoscaler maintains. 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 |
autoscalingPolicy.customMetricUtilizations[].singleInstanceAssignment |
If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing. A good metric to use with the target is for example A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilizationTarget instead. |
autoscalingPolicy.customMetricUtilizations[].utilizationTargetType |
Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either |
autoscalingPolicy.loadBalancingUtilization |
Configuration parameters of autoscaling based on load balancer. |
autoscalingPolicy.loadBalancingUtilization.utilizationTarget |
Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is |
autoscalingPolicy.mode |
Defines the operating mode for this policy. The following modes are available:
|
autoscalingPolicy.scalingSchedules[] |
Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest minRequiredReplicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed. |
autoscalingPolicy.scalingSchedules[].minRequiredReplicas |
The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required. |
autoscalingPolicy.scalingSchedules[].schedule |
The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to timeZone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving. |
autoscalingPolicy.scalingSchedules[].timeZone |
The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty. |
autoscalingPolicy.scalingSchedules[].durationSec |
The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required. |
autoscalingPolicy.scalingSchedules[].disabled |
A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default. |
autoscalingPolicy.scalingSchedules[].description |
A description of a scaling schedule. |
zone |
[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). |
region |
[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). |
selfLink |
[Output Only] Server-defined URL for the resource. |
status |
[Output Only] The status of the autoscaler configuration. Current set of possible values:
|
statusDetails[] |
[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 |
The status message. |
statusDetails[].type |
The type of error, warning, or notice returned. Current set of possible values:
|
recommendedSize |
[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. |
scalingScheduleStatus[] |
[Output Only] Status information of existing scaling schedules. |
scalingScheduleStatus[].nextStartTime |
[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format. |
scalingScheduleStatus[].lastStartTime |
[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format. |
scalingScheduleStatus[].state |
[Output Only] The current state of a scaling schedule. |
Response body
Represents an Operation resource.
Google Compute Engine has three Operation resources:
You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
Operations can be global, regional or zonal.
- For global operations, use the
globalOperations
resource. - For regional operations, use the
regionOperations
resource. - For zonal operations, use the
zoneOperations
resource.
For more information, read Global, Regional, and Zonal Resources.
Note that completed Operation resources have a limited retention period.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creationTimestamp |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the operation. |
zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
clientOperationId |
[Output Only] The value of |
operationType |
[Output Only] The type of operation, such as |
targetLink |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. |
targetId |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
statusMessage |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. |
insertTime |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
startTime |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
endTime |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error.errors[] |
[Output Only] The array of errors encountered while processing this operation. |
error.errors[].code |
[Output Only] The error type identifier for this error. |
error.errors[].location |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error.errors[].message |
[Output Only] An optional, human-readable error message. |
error.errors[].errorDetails[] |
[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. |
error.errors[].errorDetails[].errorInfo |
|
error.errors[].errorDetails[].errorInfo.reason |
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of |
error.errors[].errorDetails[].errorInfo.domain |
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". |
error.errors[].errorDetails[].errorInfo.metadatas |
Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. |
error.errors[].errorDetails[].quotaInfo |
|
error.errors[].errorDetails[].quotaInfo.metricName |
The Compute Engine quota metric name. |
error.errors[].errorDetails[].quotaInfo.limitName |
The name of the quota limit. |
error.errors[].errorDetails[].quotaInfo.dimensions |
The map holding related quota dimensions. |
error.errors[].errorDetails[].quotaInfo.limit |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
error.errors[].errorDetails[].quotaInfo.futureLimit |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
error.errors[].errorDetails[].quotaInfo.rolloutStatus |
Rollout status of the future quota limit. |
error.errors[].errorDetails[].help |
|
error.errors[].errorDetails[].help.links[] |
URL(s) pointing to additional information on handling the current error. |
error.errors[].errorDetails[].help.links[].description |
Describes what the link offers. |
error.errors[].errorDetails[].help.links[].url |
The URL of the link. |
error.errors[].errorDetails[].localizedMessage |
|
error.errors[].errorDetails[].localizedMessage.locale |
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" |
error.errors[].errorDetails[].localizedMessage.message |
The localized error message in the above locale. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[].message |
[Output Only] A human-readable description of the warning code. |
warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[].data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
httpErrorStatusCode |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
httpErrorMessage |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
selfLink |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
operationGroupId |
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a |
Union field metadata . [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following: |
|
setCommonInstanceMetadataOperationMetadata |
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
setCommonInstanceMetadataOperationMetadata.clientOperationId |
[Output Only] The client operation id. |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[] |
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state |
[Output Only] Status of the action, which can be one of the following: |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error |
[Output Only] If state is |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code |
The status code, which should be an enum value of |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field |
instancesBulkInsertOperationMetadata |
|
instancesBulkInsertOperationMetadata.perLocationStatus[] |
Status information per location (location name is key). Example key: zones/us-central1-a |
instancesBulkInsertOperationMetadata.perLocationStatus[].status |
[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. |
instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount |
[Output Only] Count of VMs originally planned to be created. |
instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount |
[Output Only] Count of VMs successfully created so far. |
instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount |
[Output Only] Count of VMs that started creating but encountered an error. |
instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount |
[Output Only] Count of VMs that got deleted during rollback. |
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.