Represents a Managed Instance Group resource.
An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
For zonal Managed Instance Group, use the instanceGroupManagers resource.
For regional Managed Instance Group, use the regionInstanceGroupManagers resource.
| 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, "adopting": integer }, "status": { "isStable": boolean, "allInstancesConfig": { "effective": boolean, "currentRevision": string }, "versionTarget": { "isReached": boolean }, "stateful": { "isStateful": boolean, "hasStatefulConfig": boolean, "perInstanceConfigs": { "allEffective": boolean } }, "autoscaler": string, "bulkInstanceOperation": { "inProgress": boolean, "lastProgressCheck": { "timestamp": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { // Union field |
kindstring
Output only. The resource type, which is always compute#instanceGroupManager for managed instance groups.
idstring (uint64 format)
Output only. A unique identifier for this resource type. The server generates this identifier.
creationTimestampstring
Output only. The creation timestamp for this managed instance group in RFC3339 text format.
namestring
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
descriptionstring
An optional description of this resource.
zonestring
Output only. The URL of a zone where the managed instance group is located (for zonal resources).
regionstring
Output only. The URL of the region where the managed instance group resides (for regional resources).
distributionPolicyobject
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. By default, a regional MIG doesn't automatically select an AI zone to create instances, even if an AI zone is available in the specified region. To create instances in an AI zone in the selected region, you must explicitly specify it in the distribution policy together with the other preferred zones.
distributionPolicy.zones[].zonestring
The URL of the zone. The zone must exist in the region where the managed instance group is located.
distributionPolicy.targetShapeenum
The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
instanceTemplatestring
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.
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[].namestring
Name of the version. Unique among all versions in the scope of this managed instance group.
versions[].instanceTemplatestring
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.
versions[].targetSizeobject
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:
targetSize.fixed or instanceGroupManager.targetSize is used.percent, the targetSize 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.fixedinteger
Specifies a fixed number of VM instances. This must be a positive integer.
versions[].targetSize.percentinteger
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
versions[].targetSize.calculatedinteger
Output only. Absolute value of VM instances calculated based on the specific mode.
fixed, then the calculated
value is equal to the fixed value.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.allInstancesConfigobject
Specifies configuration that overrides the instance template configuration for the group.
allInstancesConfig.propertiesobject
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.metadatamap (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.labelsmap (key: string, value: string)
The label key-value pairs that you want to patch onto the instance.
instanceGroupstring
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.
baseInstanceNamestring
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}\])?))
fingerprintstring (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.
currentActionsobject
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.noneinteger
Output only. The number of instances in the managed instance group that are running and have no scheduled actions.
currentActions.creatinginteger
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.creatingWithoutRetriesinteger
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.verifyinginteger
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.recreatinginteger
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.deletinginteger
Output only. The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
currentActions.abandoninginteger
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.restartinginteger
Output only. The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
currentActions.refreshinginteger
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.suspendinginteger
Output only. The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.
currentActions.resuminginteger
Output only. The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.
currentActions.stoppinginteger
Output only. The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.
currentActions.startinginteger
Output only. The number of instances in the managed instance group that are scheduled to be started or are currently being started.
currentActions.adoptinginteger
Output only. The number of instances in the managed instance group that are scheduled to be adopted or are currently being adopted.
statusobject
Output only. The status of this managed instance group.
status.isStableboolean
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.allInstancesConfigobject
Output only. Status of all-instances configuration on the group.
status.allInstancesConfig.effectiveboolean
Output only. A bit indicating whether this configuration has been applied to all managed instances in the group.
status.allInstancesConfig.currentRevisionstring
Output only. Current all-instances configuration revision. This value is in RFC3339 text format.
status.versionTargetobject
Output only. A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
status.versionTarget.isReachedboolean
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.statefulobject
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.hasStatefulConfigboolean
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.perInstanceConfigsobject
Output only. Status of per-instance configurations on the instances.
status.stateful.perInstanceConfigs.allEffectiveboolean
Output only. 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.autoscalerstring
Output only. The URL of the Autoscaler that targets this instance group manager.
status.bulkInstanceOperationobject
Output only. The status of bulk instance operation.
status.bulkInstanceOperation.inProgressboolean
Output only. Informs whether bulk instance operation is in progress.
status.bulkInstanceOperation.lastProgressCheckobject
Output only. Information from the last progress check of bulk instance operation.
status.bulkInstanceOperation.lastProgressCheck.timestampstring (Timestamp format)
Output only. Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
status.bulkInstanceOperation.lastProgressCheck.errorobject
Output only. Errors encountered during bulk instance operation.
status.bulkInstanceOperation.lastProgressCheck.error.errors[]object
Output only. The array of errors encountered while processing this operation.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].codestring
Output only. The error type identifier for this error.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].locationstring
Output only. Indicates the field in the request that caused the error. This property is optional.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].messagestring
Output only. An optional, human-readable error message.
status.bulkInstanceOperation.lastProgressCheck.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.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfoobject
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo.reasonstring
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.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo.domainstring
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".
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo.metadatasmap (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.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfoobject
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.metricNamestring
The Compute Engine quota metric name.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.limitNamestring
The name of the quota limit.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.dimensionsmap (key: string, value: string)
The map holding related quota dimensions.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.limitnumber
Current effective quota limit. The limit's unit depends on the quota type or metric.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.futureLimitnumber
Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.rolloutStatusenum
Rollout status of the future quota limit.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].helpobject
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help.links[]object
URL(s) pointing to additional information on handling the current error.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help.links[].descriptionstring
Describes what the link offers.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help.links[].urlstring
The URL of the link.
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].localizedMessageobject
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].localizedMessage.localestring
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"
status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].localizedMessage.messagestring
The localized error message in the above locale.
status.appliedAcceleratorTopologies[]object
Output only. The accelerator topology applied to this MIG. Currently only one accelerator topology is supported.
status.appliedAcceleratorTopologies[].acceleratorTopologystring
Output only. Topology in the format of: "16x16", "4x4x4", etc. The value is the same as configured in the WorkloadPolicy.
status.appliedAcceleratorTopologies[].stateenum
Output only. The state of the accelerator topology.
status.appliedAcceleratorTopologies[].stateDetailsobject
Output only. The result of the latest accelerator topology state check.
status.appliedAcceleratorTopologies[].stateDetails.timestampstring (Timestamp format)
Output only. Timestamp is shown only if there is an error. The field has // RFC3339 // text format.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
status.appliedAcceleratorTopologies[].stateDetails.errorobject
Output only. Encountered errors.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[]object
Output only. The array of errors encountered while processing this operation.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].codestring
Output only. The error type identifier for this error.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].locationstring
Output only. Indicates the field in the request that caused the error. This property is optional.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].messagestring
Output only. An optional, human-readable error message.
status.appliedAcceleratorTopologies[].stateDetails.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.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfoobject
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo.reasonstring
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.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo.domainstring
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".
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo.metadatasmap (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.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfoobject
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.metricNamestring
The Compute Engine quota metric name.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.limitNamestring
The name of the quota limit.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.dimensionsmap (key: string, value: string)
The map holding related quota dimensions.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.limitnumber
Current effective quota limit. The limit's unit depends on the quota type or metric.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.futureLimitnumber
Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.rolloutStatusenum
Rollout status of the future quota limit.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].helpobject
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help.links[]object
URL(s) pointing to additional information on handling the current error.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help.links[].descriptionstring
Describes what the link offers.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help.links[].urlstring
The URL of the link.
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].localizedMessageobject
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].localizedMessage.localestring
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"
status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].localizedMessage.messagestring
The localized error message in the above locale.
status.currentInstanceStatusesobject
Output only. The list of instance statuses and the number of instances in this managed instance group that have the status. Currently only shown for TPU MIGs
status.currentInstanceStatuses.nonExistentinteger
Output only. The number of instances that have not been created yet or have been deleted. Includes only instances that would be shown in the listManagedInstances method and not all instances that have been deleted in the lifetime of the MIG. Does not include FlexStart instances that are waiting for the resources availability, they are considered as 'pending'.
status.currentInstanceStatuses.provisioninginteger
Output only. The number of instances in the managed instance group that have PROVISIONING status.
status.currentInstanceStatuses.staginginteger
Output only. The number of instances in the managed instance group that have STAGING status.
status.currentInstanceStatuses.runninginteger
Output only. The number of instances in the managed instance group that have RUNNING status.
status.currentInstanceStatuses.stoppinginteger
Output only. The number of instances in the managed instance group that have STOPPING status.
status.currentInstanceStatuses.stoppedinteger
Output only. The number of instances in the managed instance group that have STOPPED status.
status.currentInstanceStatuses.terminatedinteger
Output only. The number of instances in the managed instance group that have TERMINATED status.
status.currentInstanceStatuses.suspendinginteger
Output only. The number of instances in the managed instance group that have SUSPENDING status.
status.currentInstanceStatuses.suspendedinteger
Output only. The number of instances in the managed instance group that have SUSPENDED status.
status.currentInstanceStatuses.repairinginteger
Output only. The number of instances in the managed instance group that have REPAIRING status.
status.currentInstanceStatuses.deprovisioninginteger
Output only. The number of instances in the managed instance group that have DEPROVISIONING status.
status.currentInstanceStatuses.pendingStopinteger
Output only. The number of instances in the managed instance group that have PENDING_STOP status.
status.currentInstanceStatuses.pendinginteger
Output only. The number of instances in the managed instance group that have PENDING status, that is FlexStart instances that are waiting for resources. Instances that do not exist because of the other reasons are counted as 'nonExistent'.
targetSizeinteger
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.
targetSizePolicyobject
The policy that specifies how the MIG creates its VMs to achieve the target size.
targetSizePolicy.modeenum
The mode of target size policy based on which the MIG creates its VMs individually or all at once.
instanceFlexibilityPolicyobject
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[].rankinteger
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.instanceSelections[].minCpuPlatformstring
Name of the minimum CPU platform to be used by this instance selection. e.g. 'Intel Ice Lake'.
instanceFlexibilityPolicy.instanceSelections[].disks[]object
regionInstanceGroupManagers.list of disks to be attached to the instances created from this selection.
instanceFlexibilityPolicy.instanceSelections[].disks[].kindstring
Output only. Type of the resource. Always compute#attachedDisk for attached disks.
instanceFlexibilityPolicy.instanceSelections[].disks[].typeenum
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
instanceFlexibilityPolicy.instanceSelections[].disks[].modeenum
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
instanceFlexibilityPolicy.instanceSelections[].disks[].savedStateenum
Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discardLocalSsd option on Stop/Suspend). Read-only in the api.
instanceFlexibilityPolicy.instanceSelections[].disks[].sourcestring
Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required.
If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.
instanceFlexibilityPolicy.instanceSelections[].disks[].deviceNamestring
Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
instanceFlexibilityPolicy.instanceSelections[].disks[].indexinteger
Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
instanceFlexibilityPolicy.instanceSelections[].disks[].bootboolean
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParamsobject
[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
This property is mutually exclusive with the source property; you can only define one or the other, but not both.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.diskNamestring
Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImagestring
The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required.
To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
projects/debian-cloud/global/images/family/debian-9
Alternatively, use a specific version of a public operating system image:
projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
To create a disk with a custom image that you created, specify the image name in the following format:
global/images/my-custom-image
You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
global/images/family/my-image-family
If the source image is deleted later, this field will not be set.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.diskSizeGbstring (int64 format)
Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.diskTypestring
Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid:
https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskTypeprojects/project/zones/zone/diskTypes/diskTypezones/zone/diskTypes/diskTypepd-standard.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKeyobject
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.rawKeystring
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.rsaEncryptedKeystring
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.kmsKeyNamestring
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.sha256string
Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.kmsKeyServiceAccountstring
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.labelsmap (key: string, value: string)
Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotstring
The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required.
To create a disk with a snapshot that you created, specify the snapshot name in the following format:
global/snapshots/my-backup
If the source snapshot is deleted later, this field will not be set.
Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the bulk insert method.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceInstantSnapshotstring
The source instant-snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required.
To create a disk with a snapshot that you created, specify the snapshot name in the following format:
us-central1-a/instantSnapshots/my-backup
If the source instant-snapshot is deleted later, this field will not be set.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKeyobject
The customer-supplied encryption key of the source snapshot.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.rawKeystring
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.rsaEncryptedKeystring
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyNamestring
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.sha256string
Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyServiceAccountstring
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.descriptionstring
An optional description. Provide this property when creating the disk.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.replicaZones[]string
Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.guestOsFeatures[]object
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.guestOsFeatures[].typeenum
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
VIRTIO_SCSI_MULTIQUEUEWINDOWSMULTI_IP_SUBNETUEFI_COMPATIBLEGVNICSEV_CAPABLESUSPEND_RESUME_COMPATIBLESEV_LIVE_MIGRATABLE_V2SEV_SNP_CAPABLETDX_CAPABLEIDPFSNP_SVSM_CAPABLECCA_CAPABLEinstanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.resourcePolicies[]string
Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.onUpdateActionenum
Specifies which action to take on instance update with this disk. Default is to use the existing disk.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.provisionedIopsstring (int64 format)
Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.multiWriterboolean
Indicates whether or not the disk can be read/write attached to more than one instance.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.licenses[]string
A list of publicly visible licenses. Reserved for Google's use.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.architectureenum
The architecture of the attached disk. Valid values are arm64 or x86_64.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.resourceManagerTagsmap (key: string, value: string)
Input only. Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/{tag_value_id} or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.provisionedThroughputstring (int64 format)
Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.enableConfidentialComputeboolean
Whether this disk is using confidential compute mode.
instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.storagePoolstring
The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePoolprojects/project/zones/zone/storagePools/storagePoolzones/zone/storagePools/storagePoolinstanceFlexibilityPolicy.instanceSelections[].disks[].autoDeleteboolean
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
instanceFlexibilityPolicy.instanceSelections[].disks[].licenses[]string
Output only. Any valid publicly visible licenses.
instanceFlexibilityPolicy.instanceSelections[].disks[].interfaceenum
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.
instanceFlexibilityPolicy.instanceSelections[].disks[].guestOsFeatures[]object
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
instanceFlexibilityPolicy.instanceSelections[].disks[].guestOsFeatures[].typeenum
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
VIRTIO_SCSI_MULTIQUEUEWINDOWSMULTI_IP_SUBNETUEFI_COMPATIBLEGVNICSEV_CAPABLESUSPEND_RESUME_COMPATIBLESEV_LIVE_MIGRATABLE_V2SEV_SNP_CAPABLETDX_CAPABLEIDPFSNP_SVSM_CAPABLECCA_CAPABLEinstanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKeyobject
Encrypts or decrypts a disk using a customer-supplied encryption key.
If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
Note:
Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
You cannot create VMs that have disks with customer-supplied keys using the bulk insert method.
instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.rawKeystring
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.rsaEncryptedKeystring
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.kmsKeyNamestring
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key
"kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.sha256string
Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.kmsKeyServiceAccountstring
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/
instanceFlexibilityPolicy.instanceSelections[].disks[].diskSizeGbstring (int64 format)
The size of the disk in GB.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialStateobject
Output only. shielded vm initial state stored on disk
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.pkobject
The Platform Key (PK).
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.pk.contentstring (bytes format)
The raw content in the secure keys file.
A base64-encoded string.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.pk.fileTypeenum
The file type of source file.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.keks[]object
The Key Exchange Key (KEK).
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.keks[].contentstring (bytes format)
The raw content in the secure keys file.
A base64-encoded string.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.keks[].fileTypeenum
The file type of source file.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbs[]object
The Key Database (db).
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbs[].contentstring (bytes format)
The raw content in the secure keys file.
A base64-encoded string.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbs[].fileTypeenum
The file type of source file.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbxs[]object
The forbidden key database (dbx).
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbxs[].contentstring (bytes format)
The raw content in the secure keys file.
A base64-encoded string.
instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbxs[].fileTypeenum
The file type of source file.
instanceFlexibilityPolicy.instanceSelections[].disks[].forceAttachboolean
[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
instanceFlexibilityPolicy.instanceSelections[].disks[].lockedboolean
Output only. Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.
instanceFlexibilityPolicy.instanceSelections[].disks[].architectureenum
Output only. The architecture of the attached disk. Valid values are ARM64 or X86_64.
instanceFlexibilityPolicy.provisioningModelMixobject
Provisioning model configuration used by this managed instance group to create instances.
instanceFlexibilityPolicy.provisioningModelMix.standardCapacityBaseinteger
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.standardCapacityPercentAboveBaseinteger
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.
targetStoppedSizeinteger
The target number of stopped instances for this managed instance group. This number changes when you:
targetStoppedSize using the update method.targetSuspendedSizeinteger
The target number of suspended instances for this managed instance group. This number changes when you:
targetSuspendedSize using the update method.listManagedInstancesResultsenum
Pagination behavior of the listManagedInstances API method for this managed instance group.
standbyPolicyobject
Standby policy for stopped and suspended instances.
standbyPolicy.initialDelaySecinteger
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.modeenum
Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is MANUAL.
selfLinkstring
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[].healthCheckstring
The URL for the health check that signals autohealing.
autoHealingPolicies[].initialDelaySecinteger
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.
updatePolicyobject
The update policy for this managed instance group.
updatePolicy.typeenum
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.instanceRedistributionTypeenum
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.minimalActionenum
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.
REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update.RESTART or REPLACE. 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 to RESTART in order to pick up metadata changes.updatePolicy.mostDisruptiveAllowedActionenum
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.maxSurgeobject
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.fixedinteger
Specifies a fixed number of VM instances. This must be a positive integer.
updatePolicy.maxSurge.percentinteger
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
updatePolicy.maxSurge.calculatedinteger
Output only. Absolute value of VM instances calculated based on the specific mode.
fixed, then the calculated
value is equal to the fixed value.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.updatePolicy.maxUnavailableobject
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:
RUNNING.HEALTHY at least once. If there is no health check
on the group, then the instance only needs to have a status of
RUNNING 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.fixedinteger
Specifies a fixed number of VM instances. This must be a positive integer.
updatePolicy.maxUnavailable.percentinteger
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
updatePolicy.maxUnavailable.calculatedinteger
Output only. Absolute value of VM instances calculated based on the specific mode.
fixed, then the calculated
value is equal to the fixed value.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.updatePolicy.minReadySecinteger
Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
updatePolicy.replacementMethodenum
What action should be used to replace instances. See minimalAction.REPLACE
namedPorts[]object
Output only. Named ports configured on the Instance Groups complementary to this Instance Group Manager.
namedPorts[].namestring
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
namedPorts[].portinteger
The port number, which can be a value between 1 and 65535.
serviceAccountstring
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.
failoverActionenum
The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
statefulPolicyobject
Stateful configuration for this Instanced Group Manager
statefulPolicy.preservedStateobject
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[].autoDeleteenum
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.
statefulPolicy.preservedState.internalIPs[].autoDeleteenum
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.
statefulPolicy.preservedState.externalIPs[].autoDeleteenum
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.
instanceLifecyclePolicyobject
The repair policy for this managed instance group.
instanceLifecyclePolicy.forceUpdateOnRepairenum
A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are:
instanceLifecyclePolicy.defaultActionOnFailureenum
The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field is DEFAULT_ACTION, then the same action also applies to the VMs on which your application fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM.
instanceLifecyclePolicy.onFailedHealthCheckenum
The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are:
DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field.REPAIR: MIG automatically repairs an unhealthy VM by recreating it.DO_NOTHING: MIG doesn't repair an unhealthy VM.instanceLifecyclePolicy.onRepairobject
Configuration for VM repairs in the MIG.
instanceLifecyclePolicy.onRepair.allowChangingZoneenum
NO (default): MIG cannot change a VM's zone during a repair.YES: MIG can select a different zone for the VM during a repair.paramsobject
Input only. Additional params passed with the request, but not persisted as part of resource payload.
params.resourceManagerTagsmap (key: string, value: string)
Input only. Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/456 or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. For more information, see Manage tags for resources.
satisfiesPziboolean
Output only. Reserved for future use.
satisfiesPzsboolean
Output only. Reserved for future use.
resourcePoliciesobject
Resource policies for this managed instance group.
resourcePolicies.workloadPolicystring
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/resourcePolicyprojects/project/regions/region/resourcePolicies/resourcePolicyregions/region/resourcePolicies/resourcePolicymultiMigstring
URL to the multi-MIG that this Managed Instance Group belongs to.
Methods |
|
|---|---|
|
Flags the specified instances to be immediately removed from the managed instance group. |
|
Flags the specified instances to be adopted to the managed instance group. |
|
Apply updates to selected instances the managed instance group. |
|
Creates instances with per-instance configurations in this regional managed instance group. |
|
Deletes the specified managed instance group and all of the instances in that group. |
|
Flags the specified instances in the managed instance group to be immediately deleted. |
|
Deletes selected per-instance configurations for the managed instance group. |
|
Returns all of the details about the specified managed instance group. |
|
Creates a managed instance group using the information that you specify in the request. |
|
Retrieves the list of managed instance groups that are contained within the specified region. |
|
Lists all errors thrown by actions on instances for a given regional managed instance group. |
|
Lists the instances in the managed instance group and instances that are scheduled to be created. |
|
Lists all of the per-instance configurations defined for the managed instance group. |
|
Updates a managed instance group using the information that you specify in the request. |
|
Inserts or patches per-instance configurations for the managed instance group. |
|
Flags the specified VM instances in the managed instance group to be immediately recreated. |
|
Changes the intended size of the managed instance group. |
|
Resizes the regional managed instance group with advanced configuration options like disabling creation retries. |
|
Flags the specified instances in the managed instance group to be resumed. |
(deprecated) |
Modifies the autohealing policy for the instances in this managed instance group. |
|
Sets the instance template to use when creating new instances or recreating instances in this group. |
|
Modifies the target pools to which all new instances in this group are assigned. |
|
Flags the specified instances in the managed instance group to be started. |
|
Flags the specified instances in the managed instance group to be immediately stopped. |
|
Flags the specified instances in the managed instance group to be immediately suspended. |
|
Returns permissions that a caller has on the specified resource. |
|
Updates a managed instance group using the information that you specify in the request. |
|
Inserts or updates per-instance configurations for the managed instance group. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-13 UTC.