Console
    Contact Us Start free

    Method: autoscalers.patch

    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/beta/projects/{project}/zones/{zone}/autoscalers

    The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

    Path parameters

    Parameters
    project

    string

    Project ID for this request.
    zone

    string

    Name of the zone for this request.

    Query parameters

    Parameters
    requestId

    string

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

    autoscaler

    string

    Name of the autoscaler to patch.

    Authorization requires one or more of the following IAM permissions on the specified resource autoscaler :

    • compute.autoscalers.get
    • compute.autoscalers.update

    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 
 , 
 "scaleDownControl" 
 : 
 { 
 "maxScaledDownReplicas" 
 : 
 { 
 "fixed" 
 : 
 integer 
 , 
 "percent" 
 : 
 integer 
 , 
 "calculated" 
 : 
 integer 
 } 
 , 
 "timeWindowSec" 
 : 
 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

    string

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

    id

    string ( uint64 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. This field is required when creating an autoscaler.

    Authorization requires the following IAM permission on the specified resource target :

    • compute.instanceGroupManagers.use
    autoscalingPolicy

    object

    The configuration parameters for the autoscaling algorithm. You can define one or more signals 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

    integer

    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

    integer

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

    object

    autoscalingPolicy.scaleDownControl.maxScaledDownReplicas

    object

    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.scaleDownControl.maxScaledDownReplicas.fixed

    integer

    Specifies a fixed number of VM instances. This must be a positive integer.

    autoscalingPolicy.scaleDownControl.maxScaledDownReplicas.percent

    integer

    Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

    autoscalingPolicy.scaleDownControl.maxScaledDownReplicas.calculated

    integer

    [Output Only] Absolute value of VM instances calculated based on the specific mode.

    • If the value is fixed , then the calculated value is equal to the fixed value.
    • If the value is a percent , then the calculated value is percent /100 * targetSize . For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
    autoscalingPolicy.scaleDownControl.timeWindowSec

    integer

    How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.

    autoscalingPolicy.scaleInControl

    object

    autoscalingPolicy.scaleInControl.maxScaledInReplicas

    object

    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

    integer

    Specifies a fixed number of VM instances. This must be a positive integer.

    autoscalingPolicy.scaleInControl.maxScaledInReplicas.percent

    integer

    Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.

    autoscalingPolicy.scaleInControl.maxScaledInReplicas.calculated

    integer

    [Output Only] Absolute value of VM instances calculated based on the specific mode.

    • If the value is fixed , then the calculated value is equal to the fixed value.
    • If the value is a percent , then the calculated value is percent /100 * targetSize . For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
    autoscalingPolicy.scaleInControl.timeWindowSec

    integer

    How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.

    autoscalingPolicy.coolDownPeriodSec

    integer

    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

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

    enum

    Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are:

    • NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics.
    • OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.
    autoscalingPolicy.customMetricUtilizations[]

    object

    Configuration parameters of autoscaling based on a custom metric.

    autoscalingPolicy.customMetricUtilizations[].utilizationTarget

    number

    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 https://www.googleapis.com/compute/v1/instance/network/received_bytes_count . The autoscaler works to keep this value constant for each of the instances.

    autoscalingPolicy.customMetricUtilizations[].singleInstanceAssignment

    number

    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 pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.

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

    string

    A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.

    For the filter to be valid for autoscaling purposes, the following rules apply:

    • You can only use the AND operator for joining selectors.
    • You can only use direct equality comparison operator ( = ) without any functions for each selector.
    • You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical.
    • The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance , the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.

      If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.

      If not specified, the type defaults to gce_instance .

    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 gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

    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 the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8 .

    autoscalingPolicy.mode

    enum

    Defines the operating mode for this policy. The following modes are available:

    • OFF : Disables the autoscaler but maintains its configuration.
    • ONLY_SCALE_OUT : Restricts the autoscaler to add VM instances only.
    • ON : Enables all autoscaler activities according to its policy.
    For more information, see "Turning off or restricting an autoscaler"
    autoscalingPolicy.scalingSchedules[]

    map (key: string, value: object)

    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

    integer

    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

    string

    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

    string

    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

    integer

    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

    boolean

    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

    string

    A description of a scaling schedule.

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

    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 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 a size greater 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 out" mode. The autoscaler can add instances but not remove any.
    • 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): There is insufficient quota for the necessary resources, such as CPU or number of instances.
    • REGION_RESOURCE_STOCKOUT (ERROR): Shown 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.
    recommendedSize

    integer

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

    map (key: string, value: object)

    [Output Only] Status information of existing scaling schedules.

    scalingScheduleStatus[].nextStartTime

    string

    [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

    string

    [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

    enum

    [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 metadata 
can be only one of the following: 
 "setCommonInstanceMetadataOperationMetadata" 
 : 
 { 
 "clientOperationId" 
 : 
 string 
 , 
 "perLocationOperations" 
 : 
 { 
 string 
 : 
 { 
 "state" 
 : 
 enum 
 , 
 "error" 
 : 
 { 
 "code" 
 : 
 integer 
 , 
 "message" 
 : 
 string 
 , 
 "details" 
 : 
 [ 
 { 
 "@type" 
 : 
 string 
 , 
 field1 
 : 
 ... 
 , 
 ... 
 } 
 ] 
 } 
 } 
 , 
 ... 
 } 
 } 
 , 
 "instancesBulkInsertOperationMetadata" 
 : 
 { 
 "perLocationStatus" 
 : 
 { 
 string 
 : 
 { 
 "status" 
 : 
 enum 
 , 
 "targetVmCount" 
 : 
 integer 
 , 
 "createdVmCount" 
 : 
 integer 
 , 
 "failedToCreateVmCount" 
 : 
 integer 
 , 
 "deletedVmCount" 
 : 
 integer 
 } 
 , 
 ... 
 } 
 } 
 // End of list of possible types for union field metadata 
. 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#operation for Operation resources.

    id

    string ( uint64 format)

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

    creationTimestamp

    string

    [Deprecated] This field is deprecated.

    name

    string

    [Output Only] Name of the operation.

    zone

    string

    [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

    clientOperationId

    string

    [Output Only] The value of requestId if you provided it in the request. Not present otherwise.

    operationType

    string

    [Output Only] The type of operation, such as insert , update , or delete , and so on.

    targetId

    string ( uint64 format)

    [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

    status

    enum

    [Output Only] The status of the operation, which can be one of the following: PENDING , RUNNING , or DONE .

    statusMessage

    string

    [Output Only] An optional textual description of the current status of the operation.

    user

    string

    [Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees) .

    progress

    integer

    [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

    string

    [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

    startTime

    string

    [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

    endTime

    string

    [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

    error

    object

    [Output Only] If errors are generated during processing of the operation, this field will be populated.

    error.errors[]

    object

    [Output Only] The array of errors encountered while processing this operation.

    error.errors[].code

    string

    [Output Only] The error type identifier for this error.

    error.errors[].location

    string

    [Output Only] Indicates the field in the request that caused the error. This property is optional.

    error.errors[].message

    string

    [Output Only] An optional, human-readable error message.

    error.errors[].errorDetails[]

    object

    [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

    object

    error.errors[].errorDetails[].errorInfo.reason

    string

    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 [A-Z][A-Z0-9_]+[A-Z0-9] , which represents UPPER_SNAKE_CASE.

    error.errors[].errorDetails[].errorInfo.domain

    string

    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

    map (key: string, value: string)

    Additional structured details about this error.

    Keys must match a regular expression of [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

    object

    error.errors[].errorDetails[].quotaInfo.metricName

    string

    The Compute Engine quota metric name.

    error.errors[].errorDetails[].quotaInfo.limitName

    string

    The name of the quota limit.

    error.errors[].errorDetails[].quotaInfo.dimensions

    map (key: string, value: string)

    The map holding related quota dimensions.

    error.errors[].errorDetails[].quotaInfo.limit

    number

    Current effective quota limit. The limit's unit depends on the quota type or metric.

    error.errors[].errorDetails[].quotaInfo.futureLimit

    number

    Future quota limit being rolled out. The limit's unit depends on the quota type or metric.

    error.errors[].errorDetails[].quotaInfo.rolloutStatus

    enum

    Rollout status of the future quota limit.

    error.errors[].errorDetails[].help

    object

    error.errors[].errorDetails[].help.links[]

    object

    URL(s) pointing to additional information on handling the current error.

    error.errors[].errorDetails[].help.links[].description

    string

    Describes what the link offers.

    error.errors[].errorDetails[].help.links[].url

    string

    The URL of the link.

    error.errors[].errorDetails[].localizedMessage

    object

    error.errors[].errorDetails[].localizedMessage.locale

    string

    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

    string

    The localized error message in the above locale.

    warnings[]

    object

    [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

    warnings[].code

    enum

    [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

    warnings[].message

    string

    [Output Only] A human-readable description of the warning code.

    warnings[].data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example:

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    warnings[].data[].key

    string

    [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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

    warnings[].data[].value

    string

    [Output Only] A warning data value corresponding to the key.

    httpErrorStatusCode

    integer

    [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

    httpErrorMessage

    string

    [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND .

    region

    string

    [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

    description

    string

    [Output Only] A textual description of the operation, which is set when the operation is created.

    operationGroupId

    string

    [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

    Union field metadata . [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following:
    setCommonInstanceMetadataOperationMetadata

    object

    [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

    setCommonInstanceMetadataOperationMetadata.clientOperationId

    string

    [Output Only] The client operation id.

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[]

    map (key: string, value: object)

    [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state

    enum

    [Output Only] Status of the action, which can be one of the following: PROPAGATING , PROPAGATED , ABANDONED , FAILED , or DONE .

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error

    object

    [Output Only] If state is ABANDONED or FAILED , this field is populated.

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code

    integer

    The status code, which should be an enum value of google.rpc.Code .

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message

    string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]

    object

    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 "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" } .

    instancesBulkInsertOperationMetadata

    object

    instancesBulkInsertOperationMetadata.perLocationStatus[]

    map (key: string, value: object)

    Status information per location (location name is key). Example key: zones/us-central1-a

    instancesBulkInsertOperationMetadata.perLocationStatus[].status

    enum

    [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.

    instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount

    integer

    [Output Only] Count of VMs originally planned to be created.

    instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount

    integer

    [Output Only] Count of VMs successfully created so far.

    instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount

    integer

    [Output Only] Count of VMs that started creating but encountered an error.

    instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount

    integer

    [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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: