project STRING Required

Project ID for this request

region STRING Required

Name of the region scoping this request

instanceGroupManager STRING Required

Name of the managed instance group to return

autoHealingPolicies[] OBJECT

autoHealingPolicies[].healthCheck STRING

The URL for the health check that signals autohealing

autoHealingPolicies[].initialDelaySec INTEGER

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]

baseInstanceName STRING

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035

creationTimestamp STRING

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format

currentActions OBJECT

currentActions.abandoning INTEGER

[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it

currentActions.creating INTEGER

[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.

If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated

currentActions.creatingWithoutRetries INTEGER

[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly

currentActions.deleting INTEGER

[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted

currentActions.none INTEGER

[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions

currentActions.recreating INTEGER

[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template

currentActions.refreshing INTEGER

[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance

currentActions.restarting INTEGER

[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted

currentActions.verifying INTEGER

[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation

description STRING

An optional description of this resource. Provide this property when you create the resource

distributionPolicy OBJECT

distributionPolicy.zones[] OBJECT

distributionPolicy.zones[].zone STRING

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

fingerprint BINARY

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

id INTEGER

[Output Only] A unique identifier for this resource type. The server generates this identifier

instanceGroup STRING

[Output Only] The URL of the Instance Group resource

instanceTemplate STRING

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group

kind STRING

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups

name STRING

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

namedPorts[] OBJECT

The named port. For example:

namedPorts[].name STRING

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

namedPorts[].port INTEGER

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

region STRING

[Output Only] The URL of the region where the managed instance group resides (for regional resources)

selfLink STRING

[Output Only] The URL for this managed instance group. The server defines this URL

status OBJECT

status.isStable BOOLEAN

[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified

targetPools[] STRING

targetSize INTEGER

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number

updatePolicy OBJECT

updatePolicy.maxSurge OBJECT

Encapsulates numeric value that can be either absolute or relative

updatePolicy.maxSurge.calculated INTEGER

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

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

updatePolicy.maxSurge.fixed INTEGER

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

updatePolicy.maxSurge.percent INTEGER

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

updatePolicy.maxUnavailable OBJECT

Encapsulates numeric value that can be either absolute or relative

updatePolicy.maxUnavailable.calculated INTEGER

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

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

updatePolicy.maxUnavailable.fixed INTEGER

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

updatePolicy.maxUnavailable.percent INTEGER

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

updatePolicy.minimalAction ENUMERATION

Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action

updatePolicy.type ENUMERATION

The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls)

versions[] OBJECT

versions[].instanceTemplate STRING

The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached

versions[].name STRING

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

versions[].targetSize OBJECT

Encapsulates numeric value that can be either absolute or relative

versions[].targetSize.calculated INTEGER

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

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

versions[].targetSize.fixed INTEGER

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

versions[].targetSize.percent INTEGER

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

zone STRING

[Output Only] The URL of the zone where the managed instance group is located (for zonal resources)