/

Console

• English
• Deutsch
• Español – América Latina
• Français
• Português – Brasil
• 中文 – 简体
• 日本語
• 한국어

Sign in

• Compute Engine

Start free

Method: instanceGroupManagers.patch

{
  "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": {
      "hasStatefulConfig": boolean,
      "perInstanceConfigs": {
        "allEffective": boolean
      }
    },
    "autoscaler": string,
    "bulkInstanceOperation": {
      "inProgress": boolean,
      "lastProgressCheck": {
        "timestamp": string,
        "error": {
          "errors": [
            {
              "code": string,
              "location": string,
              "message": string,
              "errorDetails": [
                {

                  // Union field details_oneof can be only one of the following:
                  "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
                  }
                  // End of list of possible types for union field details_oneof.
                }
              ]
            }
          ]
        }
      }
    },
    "appliedAcceleratorTopologies": [
      {
        "acceleratorTopology": string,
        "state": enum,
        "stateDetails": {
          "timestamp": string,
          "error": {
            "errors": [
              {
                "code": string,
                "location": string,
                "message": string,
                "errorDetails": [
                  {

                    // Union field details_oneof can be only one of the following:
                    "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
                    }
                    // End of list of possible types for union field details_oneof.
                  }
                ]
              }
            ]
          }
        }
      }
    ],
    "currentInstanceStatuses": {
      "nonExistent": integer,
      "provisioning": integer,
      "staging": integer,
      "running": integer,
      "stopping": integer,
      "stopped": integer,
      "terminated": integer,
      "suspending": integer,
      "suspended": integer,
      "repairing": integer,
      "deprovisioning": integer,
      "pendingStop": integer,
      "pending": integer
    }
  },
  "targetSize": integer,
  "targetSizePolicy": {
    "mode": enum
  },
  "instanceFlexibilityPolicy": {
    "instanceSelections": {
      string: {
        "machineTypes": [
          string
        ],
        "rank": 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
    },
    "replacementMethod": enum
  },
  "namedPorts": [
    {
      "name": string,
      "port": integer
    }
  ],
  "statefulPolicy": {
    "preservedState": {
      "disks": {
        string: {
          "autoDelete": enum
        },
        ...
      },
      "internalIPs": {
        string: {
          "autoDelete": enum
        },
        ...
      },
      "externalIPs": {
        string: {
          "autoDelete": enum
        },
        ...
      }
    }
  },
  "instanceLifecyclePolicy": {
    "forceUpdateOnRepair": enum,
    "defaultActionOnFailure": enum,
    "onFailedHealthCheck": enum,
    "onRepair": {
      "allowChangingZone": enum
    }
  },
  "satisfiesPzi": boolean,
  "satisfiesPzs": boolean,
  "resourcePolicies": {
    "workloadPolicy": string
  }
}

string

Output only. The resource type, which is always compute#instanceGroupManager for managed instance groups.

string (uint64 format)

Output only. A unique identifier for this resource type. The server generates this identifier.

string

Output only. The creation timestamp for this managed instance group in RFC3339 text format.

string

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

string

An optional description of this resource.

string

Output only. The URL of a zone where the managed instance group is located (for zonal resources).

string

Output only. The URL of the region where the managed instance group resides (for regional resources).

object

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

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.

string

The URL of the zone. The zone must exist in the region where the managed instance group is located.

enum

The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).

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

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.

string

Name of the version. Unique among all versions in the scope of this managed instance group.

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

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 or instanceGroupManager.targetSize is used.
• if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded.

integer

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

integer

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

integer

Output only. Absolute value of VM instances calculated based on the specific mode.

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

object

Specifies configuration that overrides the instance template configuration for the group.

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.

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.

map (key: string, value: string)

The label key-value pairs that you want to patch onto the instance.

string

Output only. The URL of the Instance Group resource.

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

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}\])?))

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.

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.

integer

Output only. The number of instances in the managed instance group that are running and have no scheduled actions.

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.

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.

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.

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.

integer

Output only. The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

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.

integer

Output only. The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

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.

integer

Output only. The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.

integer

Output only. The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.

integer

Output only. The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.

integer

Output only. The number of instances in the managed instance group that are scheduled to be started or are currently being started.

object

Output only. The status of this managed instance group.

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.

object

Output only. Status of all-instances configuration on the group.

boolean

Output only. A bit indicating whether this configuration has been applied to all managed instances in the group.

string

Output only. Current all-instances configuration revision. This value is in RFC3339 text format.

object

Output only. A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.

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.

object

Output only. Stateful status of the given Instance Group Manager.

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.

object

Output only. Status of per-instance configurations on the instances.

boolean

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.

string

Output only. The URL of the Autoscaler that targets this instance group manager.

object

Output only. The status of bulk instance operation.

boolean

Output only. Informs whether bulk instance operation is in progress.

object

Output only. Information from the last progress check of bulk instance operation.

string (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".

object

Output only. Errors encountered during bulk instance operation.

object

Output only. The array of errors encountered while processing this operation.

string

Output only. The error type identifier for this error.

string

Output only. Indicates the field in the request that caused the error. This property is optional.

string

Output only. An optional, human-readable error message.

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.

object

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.

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

map (key: string, value: string)

Additional structured details about this error.

Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

object

string

The Compute Engine quota metric name.

string

The name of the quota limit.

map (key: string, value: string)

The map holding related quota dimensions.

number

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

number

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

enum

Rollout status of the future quota limit.

object

object

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

string

Describes what the link offers.

string

The URL of the link.

object

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"

string

The localized error message in the above locale.

object

Output only. The accelerator topology applied to this MIG. Currently only one accelerator topology is supported.

string

Output only. Topology in the format of: "16x16", "4x4x4", etc. The value is the same as configured in the WorkloadPolicy.

enum

Output only. The state of the accelerator topology.

object

Output only. The result of the latest accelerator topology state check.

string (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".

object

Output only. Encountered errors.

object

Output only. The array of errors encountered while processing this operation.

string

Output only. The error type identifier for this error.

string

Output only. Indicates the field in the request that caused the error. This property is optional.

string

Output only. An optional, human-readable error message.

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.

object

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.

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

map (key: string, value: string)

Additional structured details about this error.

Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

object

string

The Compute Engine quota metric name.

string

The name of the quota limit.

map (key: string, value: string)

The map holding related quota dimensions.

number

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

number

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

enum

Rollout status of the future quota limit.

object

object

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

string

Describes what the link offers.

string

The URL of the link.

object

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"

string

The localized error message in the above locale.

object

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

integer

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

integer

Output only. The number of instances in the managed instance group that have PROVISIONING status.

integer

Output only. The number of instances in the managed instance group that have STAGING status.

integer

Output only. The number of instances in the managed instance group that have RUNNING status.

integer

Output only. The number of instances in the managed instance group that have STOPPING status.

integer

Output only. The number of instances in the managed instance group that have STOPPED status.

integer

Output only. The number of instances in the managed instance group that have TERMINATED status.

integer

Output only. The number of instances in the managed instance group that have SUSPENDING status.

integer

Output only. The number of instances in the managed instance group that have SUSPENDED status.

integer

Output only. The number of instances in the managed instance group that have REPAIRING status.

integer

Output only. The number of instances in the managed instance group that have DEPROVISIONING status.

integer

Output only. The number of instances in the managed instance group that have PENDING_STOP status.

integer

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

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.

object

The policy that specifies how the MIG creates its VMs to achieve the target size.

enum

The mode of target size policy based on which the MIG creates its VMs individually or all at once.

object

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

map (key: string, value: object)

Named instance selections configuring properties that the group will use when creating new VMs.

string

Full machine-type names, e.g. "n1-standard-16".

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.

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.

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.

enum

Pagination behavior of the listManagedInstances API method for this managed instance group.

object

Standby policy for stopped and suspended instances.

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.

enum

Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is MANUAL.

string

Output only. The URL for this managed instance group. The server defines this URL.

object

The autohealing policy for this managed instance group. You can specify only one value.

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

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.

object

The update policy for this managed instance group.

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.

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.

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

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.

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.

integer

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

integer

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

integer

Output only. Absolute value of VM instances calculated based on the specific mode.

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

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

integer

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

integer

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

integer

Output only. Absolute value of VM instances calculated based on the specific mode.

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

enum

What action should be used to replace instances. See minimalAction.REPLACE

object

Output only. Named ports configured on the Instance Groups complementary to this Instance Group Manager.

string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

integer

The port number, which can be a value between 1 and 65535.

object

Stateful configuration for this Instanced Group Manager

object

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.

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.

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

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.

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

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.

object

The repair policy for this managed instance group.

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.

enum

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.

enum

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.
For more information, see About repairing VMs in a MIG.

object

Configuration for VM repairs in the MIG.

enum

boolean

Output only. Reserved for future use.

boolean

Output only. Reserved for future use.

object

Resource policies for this managed instance group.

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

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string,
        "errorDetails": [
          {
            "errorInfo": {
              "reason": string,
              "domain": string,
              "metadatas": {
                string: string,
                ...
              }
            },
            "quotaInfo": {
              "metricName": string,
              "limitName": string,
              "dimensions": {
                string: string,
                ...
              },
              "limit": number,
              "futureLimit": number,
              "rolloutStatus": enum
            },
            "help": {
              "links": [
                {
                  "description": string,
                  "url": string
                }
              ]
            },
            "localizedMessage": {
              "locale": string,
              "message": string
            }
          }
        ]
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "operationGroupId": string,

  // Union field metadata can be only one of the following:
  "setCommonInstanceMetadataOperationMetadata": {
    "clientOperationId": string,
    "perLocationOperations": {
      string: {
        "state": enum,
        "error": {
          "code": integer,
          "message": string,
          "details": [
            {
              "@type": string,
              field1: ...,
              ...
            }
          ]
        }
      },
      ...
    }
  },
  "instancesBulkInsertOperationMetadata": {
    "perLocationStatus": {
      string: {
        "status": enum,
        "targetVmCount": integer,
        "createdVmCount": integer,
        "failedToCreateVmCount": integer,
        "deletedVmCount": integer
      },
      ...
    }
  },
  "getVersionOperationMetadata": {
    "inlineSbomInfo": {
      "currentComponentVersions": {
        string: string,
        ...
      },
      "targetComponentVersions": {
        string: string,
        ...
      }
    }
  }
  // End of list of possible types for union field metadata.
}

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