- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE
when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.
HTTP request
PUT https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
instanceGroupManager |
The name of the instance group manager. Authorization requires the following IAM permission on the specified resource
|
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 ( |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "zone": string, "region": string, "distributionPolicy": { "zones": [ { "zone": string } ], "targetShape": enum }, "instanceTemplate": string, "versions": [ { "name": string, "instanceTemplate": string, "targetSize": { "fixed": integer, "percent": integer, "calculated": integer } } ], "allInstancesConfig": { "properties": { "metadata": { string: string, ... }, "labels": { string: string, ... } } }, "instanceGroup": string, "targetPools": [ string ], "baseInstanceName": string, "fingerprint": string, "currentActions": { "none": integer, "creating": integer, "creatingWithoutRetries": integer, "verifying": integer, "recreating": integer, "deleting": integer, "abandoning": integer, "restarting": integer, "refreshing": integer, "suspending": integer, "resuming": integer, "stopping": integer, "starting": integer }, "status": { "isStable": boolean, "allInstancesConfig": { "effective": boolean, "currentRevision": string }, "versionTarget": { "isReached": boolean }, "stateful": { "isStateful": boolean, "hasStatefulConfig": boolean, "perInstanceConfigs": { "allEffective": boolean } }, "autoscaler": string }, "targetSize": integer, "instanceFlexibilityPolicy": { "instanceSelections": { string: { "machineTypes": [ string ], "rank": integer }, ... }, "provisioningModelMix": { "standardCapacityBase": integer, "standardCapacityPercentAboveBase": integer } }, "targetStoppedSize": integer, "targetSuspendedSize": integer, "listManagedInstancesResults": enum, "standbyPolicy": { "initialDelaySec": integer, "mode": enum }, "selfLink": string, "autoHealingPolicies": [ { "healthCheck": string, "initialDelaySec": integer } ], "updatePolicy": { "type": enum, "instanceRedistributionType": enum, "minimalAction": enum, "mostDisruptiveAllowedAction": enum, "maxSurge": { "fixed": integer, "percent": integer, "calculated": integer }, "maxUnavailable": { "fixed": integer, "percent": integer, "calculated": integer }, "minReadySec": integer, "replacementMethod": enum }, "namedPorts": [ { "name": string, "port": integer } ], "serviceAccount": string, "failoverAction": enum, "statefulPolicy": { "preservedState": { "disks": { string: { "autoDelete": enum }, ... }, "internalIPs": { string: { "autoDelete": enum }, ... }, "externalIPs": { string: { "autoDelete": enum }, ... } } }, "instanceLifecyclePolicy": { "forceUpdateOnRepair": enum, "defaultActionOnFailure": enum }, "params": { "resourceManagerTags": { string: string, ... } }, "satisfiesPzi": boolean, "satisfiesPzs": boolean } |
Fields | |
---|---|
kind |
[Output Only] The resource type, which is always |
id |
[Output Only] A unique identifier for this resource type. The server generates this identifier. |
creationTimestamp |
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. |
name |
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. |
description |
An optional description of this resource. |
zone |
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources). |
region |
[Output Only] The URL of the region where the managed instance group resides (for regional resources). |
distributionPolicy |
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. |
distributionPolicy.zones[] |
Zones where the regional managed instance group will create and manage its instances. |
distributionPolicy.zones[].zone |
[REQUIRED] The URL of the zone. The zone must exist in the region where the managed instance group is located. |
distributionPolicy.targetShape |
The distribution shape to which the group converges either proactively or on resize events (depending on the value set in |
instanceTemplate |
The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run Authorization requires one or more of the following IAM permissions on the specified resource
|
versions[] |
Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an |
versions[].name |
Name of the version. Unique among all versions in the scope of this managed instance group. |
versions[].instanceTemplate |
The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the Authorization requires one or more of the following IAM permissions on the specified resource
|
versions[].targetSize |
Specifies the intended number of instances to be created from the
version . Read Starting a canary update for more information.
|
versions[].targetSize.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
versions[].targetSize.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
versions[].targetSize.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
allInstancesConfig |
Specifies configuration that overrides the instance template configuration for the group. |
allInstancesConfig.properties |
Properties to set on all instances in the group. You can add or modify properties using the |
allInstancesConfig.properties.metadata |
The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata. |
allInstancesConfig.properties.labels |
The label key-value pairs that you want to patch onto the instance. |
instanceGroup |
[Output Only] The URL of the Instance Group resource. |
targetPools[] |
The URLs for all TargetPool resources to which instances in the Authorization requires the following IAM permission on the specified resource
|
baseInstanceName |
The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\[[0-9]{1,10}\])?)) |
fingerprint |
Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error To see the latest fingerprint, make a A base64-encoded string. |
currentActions |
[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. |
currentActions.none |
[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. |
currentActions.creating |
[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the |
currentActions.creatingWithoutRetries |
[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's |
currentActions.verifying |
[Output Only] The number of instances in the managed instance group that are being verified. See the |
currentActions.recreating |
[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. |
currentActions.deleting |
[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. |
currentActions.abandoning |
[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. |
currentActions.restarting |
[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. |
currentActions.refreshing |
[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. |
currentActions.suspending |
[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. |
currentActions.resuming |
[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. |
currentActions.stopping |
[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. |
currentActions.starting |
[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started. |
status |
[Output Only] The status of this managed instance group. |
status.isStable |
[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. |
status.allInstancesConfig |
[Output only] Status of all-instances configuration on the group. |
status.allInstancesConfig.effective |
[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group. |
status.allInstancesConfig.currentRevision |
[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format. |
status.versionTarget |
[Output Only] A status of consistency of Instances' versions with their target version specified by |
status.versionTarget.isReached |
[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by |
status.stateful |
[Output Only] Stateful status of the given Instance Group Manager. |
status.stateful.isStateful |
[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of hasStatefulConfig. |
status.stateful.hasStatefulConfig |
[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. |
status.stateful.perInstanceConfigs |
[Output Only] Status of per-instance configurations on the instances. |
status.stateful.perInstanceConfigs.allEffective |
A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status |
status.autoscaler |
[Output Only] The URL of the Autoscaler that targets this instance group manager. |
targetSize |
The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. |
instanceFlexibilityPolicy |
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. |
instanceFlexibilityPolicy.instanceSelections[] |
Named instance selections configuring properties that the group will use when creating new VMs. |
instanceFlexibilityPolicy.instanceSelections[].machineTypes[] |
Full machine-type names, e.g. "n1-standard-16". |
instanceFlexibilityPolicy.instanceSelections[].rank |
Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. |
instanceFlexibilityPolicy.provisioningModelMix |
Provisioning model configuration used by this managed instance group to create instances. |
instanceFlexibilityPolicy.provisioningModelMix.standardCapacityBase |
The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity user needs. MIG will create only Standard VMs until it reaches standardCapacityBase and only then will start using standardCapacityPercentAboveBase to mix Spot with Standard VMs. |
instanceFlexibilityPolicy.provisioningModelMix.standardCapacityPercentAboveBase |
The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standardCapacityBase. |
targetStoppedSize |
The target number of stopped instances for this managed instance group. This number changes when you:
|
targetSuspendedSize |
The target number of suspended instances for this managed instance group. This number changes when you:
|
listManagedInstancesResults |
Pagination behavior of the |
standbyPolicy |
Standby policy for stopped and suspended instances. |
standbyPolicy.initialDelaySec |
Specifies the number of seconds that the MIG should wait to suspend or stop a VM after that VM was created. The initial delay gives the initialization script the time to prepare your VM for a quick scale out. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. |
standbyPolicy.mode |
Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is |
selfLink |
[Output Only] The URL for this managed instance group. The server defines this URL. |
autoHealingPolicies[] |
The autohealing policy for this managed instance group. You can specify only one value. |
autoHealingPolicies[].healthCheck |
The URL for the health check that signals autohealing. Authorization requires the following IAM permission on the specified resource
|
autoHealingPolicies[].initialDelaySec |
The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. |
updatePolicy |
The update policy for this managed instance group. |
updatePolicy.type |
The type of update process. You can specify either |
updatePolicy.instanceRedistributionType |
The instance redistribution policy for regional managed instance groups. Valid values are:
|
updatePolicy.minimalAction |
Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary.
|
updatePolicy.mostDisruptiveAllowedAction |
Most disruptive action that is allowed to be taken on an instance. You can specify either |
updatePolicy.maxSurge |
The maximum number of instances that can be created above the specified At least one of either |
updatePolicy.maxSurge.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
updatePolicy.maxSurge.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
updatePolicy.maxSurge.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
updatePolicy.maxUnavailable |
The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for At least one of either |
updatePolicy.maxUnavailable.fixed |
Specifies a fixed number of VM instances. This must be a positive integer. |
updatePolicy.maxUnavailable.percent |
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify |
updatePolicy.maxUnavailable.calculated |
[Output Only] Absolute value of VM instances calculated based on the specific mode.
|
updatePolicy.minReadySec |
Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. |
updatePolicy.replacementMethod |
What action should be used to replace instances. See minimalAction.REPLACE |
namedPorts[] |
Named ports configured for the Instance Groups complementary to this Instance Group Manager. |
namedPorts[].name |
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. |
namedPorts[].port |
The port number, which can be a value between 1 and 65535. |
serviceAccount |
The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. |
failoverAction |
The action to perform in case of zone failure. Only one value is supported, |
statefulPolicy |
Stateful configuration for this Instanced Group Manager |
statefulPolicy.preservedState |
|
statefulPolicy.preservedState.disks[] |
Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. |
statefulPolicy.preservedState.disks[].autoDelete |
These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in |
statefulPolicy.preservedState.internalIPs[] |
Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. Authorization requires one or more of the following IAM permissions on the specified resource
|
statefulPolicy.preservedState.internalIPs[].autoDelete |
These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. |
statefulPolicy.preservedState.externalIPs[] |
External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. Authorization requires one or more of the following IAM permissions on the specified resource
|
statefulPolicy.preservedState.externalIPs[].autoDelete |
These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. |
instanceLifecyclePolicy |
The repair policy for this managed instance group. |
instanceLifecyclePolicy.forceUpdateOnRepair |
A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are:
|
instanceLifecyclePolicy.defaultActionOnFailure |
The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are
|
params |
Input only. Additional params passed with the request, but not persisted as part of resource payload. |
params.resourceManagerTags |
Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources. |
satisfiesPzi |
[Output Only] Reserved for future use. |
satisfiesPzs |
[Output Only] Reserved for future use. |
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 persistent 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.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.disks.create
compute.images.useReadOnly
compute.instances.create
compute.instances.setMetadata
compute.subnetworks.use
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.