- 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 patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances
method. This method supports PATCH
semantics and uses the JSON merge patch
format and processing rules.
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
PATCH https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
The URL uses gRPC Transcoding syntax.
Path parameters
project
string
Project ID for this request.
region
string
Name of the region scoping this request.
instanceGroupManager
string
The name of the instance group manager.
Authorization requires one or more of the following IAM
permissions on the specified resource instanceGroupManager
:
-
compute.instanceGroupManagers.get
-
compute.instanceGroupManagers.update
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 , "resourcePolicies" : { "workloadPolicy" : string } } |
kind
string
[Output Only] The resource type, which is always compute#instanceGroupManager
for managed instance groups.
id
string ( uint64
format)
[Output Only] A unique identifier for this resource type. The server generates this identifier.
name
string
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035 .
description
string
An optional description of this resource.
zone
string
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
region
string
[Output Only] The URL of the region where the managed instance group resides (for regional resources).
distributionPolicy
object
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
distributionPolicy.zones[]
object
Zones where the regional managed instance group will create and manage its instances.
distributionPolicy.zones[].zone
string
The URL of the zone . The zone must exist in the region where the managed instance group is located.
distributionPolicy.targetShape
enum
The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType
).
instanceTemplate
string
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 recreateInstances
, run applyUpdatesToInstances
, or set the group's updatePolicy.type
to PROACTIVE
.
Authorization requires one or more of the following IAM
permissions on the specified resource instanceTemplate
:
-
compute.instanceTemplates.get
-
compute.instanceTemplates.useReadOnly
versions[]
object
Specifies the instance templates used by this managed instance group to create instances.
Each version is defined by an instanceTemplate
and a name
. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate
field. Read more about the relationships between these fields
. Exactly one version
must leave the targetSize
field unset. That version will be applied to all remaining instances. For more information, read about canary updates
.
versions[].name
string
Name of the version. Unique among all versions in the scope of this managed instance group.
versions[].instanceTemplate
string
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 targetSize
for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances
, run applyUpdatesToInstances
, or set the group's updatePolicy.type
to PROACTIVE
; in those cases, existing instances are updated until the targetSize
for this version is reached.
Authorization requires one or more of the following IAM
permissions on the specified resource instanceTemplate
:
-
compute.instanceTemplates.get
-
compute.instanceTemplates.useReadOnly
versions[].targetSize
object
Specifies the intended number of instances to be created from the instanceTemplate
. The final number of instances created from the template will be equal to:
- If expressed as a fixed number, the minimum of either
targetSize.fixed
orinstanceGroupManager.targetSize
is used. - if expressed as a
percent
, thetargetSize
would be(targetSize.percent/100 * InstanceGroupManager.targetSize)
If there is a remainder, the number is rounded.
version
. Read Starting a canary update
for more information.versions[].targetSize.fixed
integer
Specifies a fixed number of VM instances. This must be a positive integer.
versions[].targetSize.percent
integer
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80
for 80%.
versions[].targetSize.calculated
integer
[Output Only] Absolute value of VM instances calculated based on the specific mode.
- If the value is
fixed
, then thecalculated
value is equal to thefixed
value. - If the value is a
percent
, then thecalculated
value ispercent
/100 *targetSize
. For example, thecalculated
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.
allInstancesConfig
object
Specifies configuration that overrides the instance template configuration for the group.
allInstancesConfig.properties
object
Properties to set on all instances in the group.
You can add or modify properties using the instanceGroupManagers.patch
or regionInstanceGroupManagers.patch
. After setting allInstancesConfig
on the group, you must update the group's instances to apply the configuration. To apply the configuration, set the group's updatePolicy.type
field to use proactive updates or use the applyUpdatesToInstances
method.
allInstancesConfig.properties.metadata
map (key: string, value: string)
The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata .
allInstancesConfig.properties.labels
map (key: string, value: string)
The label key-value pairs that you want to patch onto the instance.
instanceGroup
string
[Output Only] The URL of the Instance Group resource.
targetPools[]
string
The URLs for all TargetPool resources to which instances in the instanceGroup
field are added. The target pools automatically apply to all of the instances in the managed instance group.
Authorization requires the following IAM
permission on the specified resource targetPools
:
-
compute.targetPools.get
baseInstanceName
string
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
string ( bytes
format)
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 412 conditionNotMet
.
To see the latest fingerprint, make a get()
request to retrieve an InstanceGroupManager.
A base64-encoded string.
currentActions
object
[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
integer
[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
currentActions.creating
integer
[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 creatingWithoutRetries
field will be populated.
currentActions.creatingWithoutRetries
integer
[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 targetSize
value accordingly.
currentActions.verifying
integer
[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction
property in the listManagedInstances
method documentation.
currentActions.recreating
integer
[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
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
currentActions.abandoning
integer
[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
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
currentActions.refreshing
integer
[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
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.
currentActions.resuming
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.
currentActions.stopping
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.
currentActions.starting
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.
status
object
[Output Only] The status of this managed instance group.
status.isStable
boolean
[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
object
[Output only] Status of all-instances configuration on the group.
status.allInstancesConfig.effective
boolean
[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.
status.allInstancesConfig.currentRevision
string
[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.
status.versionTarget
object
[Output Only] A status of consistency of Instances' versions with their target version specified by version
field on Instance Group Manager.
status.versionTarget.isReached
boolean
[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 version
field on Instance Group Manager.
status.stateful
object
[Output Only] Stateful status of the given Instance Group Manager.
status.stateful.isStateful
(deprecated)
boolean
[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
boolean
[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
object
[Output Only] Status of per-instance configurations on the instances.
status.stateful.perInstanceConfigs.allEffective
boolean
A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE
or there are no per-instance-configs.
status.autoscaler
string
[Output Only] The URL of the Autoscaler that targets this instance group manager.
targetSize
integer
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
object
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
instanceFlexibilityPolicy.instanceSelections[]
map (key: string, value: object)
Named instance selections configuring properties that the group will use when creating new VMs.
instanceFlexibilityPolicy.instanceSelections[].machineTypes[]
string
Full machine-type names, e.g. "n1-standard-16".
instanceFlexibilityPolicy.instanceSelections[].rank
integer
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
object
Provisioning model configuration used by this managed instance group to create instances.
instanceFlexibilityPolicy.provisioningModelMix.standardCapacityBase
integer
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
integer
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
integer
The target number of stopped instances for this managed instance group. This number changes when you:
- Stop instance using the stopInstances method or start instances using the startInstances method.
- Manually change the
targetStoppedSize
using the update method.
targetSuspendedSize
integer
The target number of suspended instances for this managed instance group. This number changes when you:
- Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.
- Manually change the
targetSuspendedSize
using the update method.
listManagedInstancesResults
enum
Pagination behavior of the listManagedInstances
API method for this managed instance group.
standbyPolicy
object
Standby policy for stopped and suspended instances.
standbyPolicy.initialDelaySec
integer
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
enum
Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is MANUAL
.
selfLink
string
[Output Only] The URL for this managed instance group. The server defines this URL.
autoHealingPolicies[]
object
The autohealing policy for this managed instance group. You can specify only one value.
autoHealingPolicies[].healthCheck
string
The URL for the health check that signals autohealing.
Authorization requires one or more of the following IAM
permissions on the specified resource healthCheck
:
-
compute.healthChecks.use
-
compute.httpHealthChecks.use
-
compute.httpsHealthChecks.use
autoHealingPolicies[].initialDelaySec
integer
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
object
The update policy for this managed instance group.
updatePolicy.type
enum
The type of update process
. You can specify either PROACTIVE
so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC
so that you can select the VMs that you want to update.
updatePolicy.instanceRedistributionType
enum
The instance redistribution policy for regional managed instance groups. Valid values are:
-
PROACTIVE
(default): The group attempts to maintain an even distribution of VM instances across zones in the region. -
NONE
: For non-autoscaled groups, proactive redistribution is disabled.
updatePolicy.minimalAction
enum
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.
- To limit disruption as much as possible, set the minimal action to
REFRESH
. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to
RESTART
orREPLACE
. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action toRESTART
in order to pick up metadata changes.
updatePolicy.mostDisruptiveAllowedAction
enum
Most disruptive action that is allowed to be taken on an instance. You can specify either NONE
to forbid any actions, REFRESH
to avoid restarting the VM and to limit disruption as much as possible. RESTART
to allow actions that can be applied without instance replacing or REPLACE
to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
updatePolicy.maxSurge
object
The maximum number of instances that can be created above the specified targetSize
during the update process. 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 maxSurge
is a fixed value equal to the number of zones in which the managed instance group operates.
At least one of either maxSurge
or maxUnavailable
must be greater than 0. Learn more about maxSurge
.
updatePolicy.maxSurge.fixed
integer
Specifies a fixed number of VM instances. This must be a positive integer.
updatePolicy.maxSurge.percent
integer
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80
for 80%.
updatePolicy.maxSurge.calculated
integer
[Output Only] Absolute value of VM instances calculated based on the specific mode.
- If the value is
fixed
, then thecalculated
value is equal to thefixed
value. - If the value is a
percent
, then thecalculated
value ispercent
/100 *targetSize
. For example, thecalculated
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.
updatePolicy.maxUnavailable
object
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:
- The instance's status
is
RUNNING
. - If there is a health
check
on the instance group, the instance's health check status
must be
HEALTHY
at least once. If there is no health check on the group, then the instance only needs to have a status ofRUNNING
to be considered available.
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 maxUnavailable
is a fixed value equal to the number of zones in which the managed instance group operates.
At least one of either maxSurge
or maxUnavailable
must be greater than 0. Learn more about maxUnavailable
.
updatePolicy.maxUnavailable.fixed
integer
Specifies a fixed number of VM instances. This must be a positive integer.
updatePolicy.maxUnavailable.percent
integer
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80
for 80%.
updatePolicy.maxUnavailable.calculated
integer
[Output Only] Absolute value of VM instances calculated based on the specific mode.
- If the value is
fixed
, then thecalculated
value is equal to thefixed
value. - If the value is a
percent
, then thecalculated
value ispercent
/100 *targetSize
. For example, thecalculated
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.
updatePolicy.minReadySec
integer
Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
updatePolicy.replacementMethod
enum
What action should be used to replace instances. See minimalAction.REPLACE
namedPorts[]
object
Named ports configured for the Instance Groups complementary to this Instance Group Manager.
namedPorts[].name
string
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035 .
namedPorts[].port
integer
The port number, which can be a value between 1 and 65535.
serviceAccount
string
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
enum
The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER
. The default is NO_FAILOVER
.
statefulPolicy
object
Stateful configuration for this Instanced Group Manager
statefulPolicy.preservedState
object
statefulPolicy.preservedState.disks[]
map (key: string, value: object)
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
enum
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 READ_ONLY
mode cannot be auto-deleted.
statefulPolicy.preservedState.internalIPs[]
map (key: string, value: object)
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 internalIPs
:
-
compute.addresses.createInternal
-
compute.addresses.deleteInternal
-
compute.addresses.get
-
compute.addresses.useInternal
statefulPolicy.preservedState.internalIPs[].autoDelete
enum
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[]
map (key: string, value: object)
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 externalIPs
:
-
compute.addresses.create
-
compute.addresses.delete
-
compute.addresses.get
-
compute.addresses.use
statefulPolicy.preservedState.externalIPs[].autoDelete
enum
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
object
The repair policy for this managed instance group.
instanceLifecyclePolicy.forceUpdateOnRepair
enum
A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are:
- NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy.
- YES: If configuration updates are available, they are applied during repair.
instanceLifecyclePolicy.defaultActionOnFailure
enum
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
-
REPAIR
(default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG . -
DO_NOTHING
: MIG does not repair a failed or an unhealthy VM.
params
object
Input only. Additional params passed with the request, but not persisted as part of resource payload.
params.resourceManagerTags
map (key: string, value: string)
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
boolean
[Output Only] Reserved for future use.
satisfiesPzs
boolean
[Output Only] Reserved for future use.
resourcePolicies
object
Resource policies for this managed instance group.
resourcePolicies.workloadPolicy
string
The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy:
-
https://www.googleapis.com/compute/v1/projects/ project /regions/ region /resourcePolicies/ resourcePolicy
-
projects/ project /regions/ region /resourcePolicies/ resourcePolicy
-
regions/ region /resourcePolicies/ resourcePolicy
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 |
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.
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.
targetLink
string
[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
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
.
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.
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-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.
selfLink
string
[Output Only] Server-defined URL for the resource.
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.
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.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 .
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 .