project STRING Required

Project ID for this request

zone STRING Required

The name of the zone where the managed instance group is located

filter STRING

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

maxResults INTEGER

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

orderBy STRING

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported

pageToken STRING

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

id STRING

[Output Only] Unique identifier for the resource; defined by the server

items[] OBJECT

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. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==)

items[].autoHealingPolicies[] OBJECT

items[].autoHealingPolicies[].healthCheck STRING

The URL for the health check that signals autohealing

items[].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]

items[].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

items[].creationTimestamp STRING

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

items[].currentActions OBJECT

items[].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

items[].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

items[].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

items[].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

items[].currentActions.none INTEGER

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

items[].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

items[].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

items[].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

items[].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

items[].description STRING

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

items[].distributionPolicy OBJECT

items[].distributionPolicy.zones[] OBJECT

items[].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

items[].id INTEGER

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

items[].instanceGroup STRING

[Output Only] The URL of the Instance Group resource

items[].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

items[].kind STRING

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

items[].name STRING

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

items[].namedPorts[] OBJECT

The named port. For example:

items[].namedPorts[].name STRING

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

items[].namedPorts[].port INTEGER

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

items[].region STRING

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

items[].selfLink STRING

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

items[].status OBJECT

items[].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

items[].targetPools[] STRING

items[].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

items[].updatePolicy OBJECT

items[].updatePolicy.maxSurge OBJECT

Encapsulates numeric value that can be either absolute or relative

items[].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.

items[].updatePolicy.maxSurge.fixed INTEGER

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

items[].updatePolicy.maxSurge.percent INTEGER

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

items[].updatePolicy.maxUnavailable OBJECT

Encapsulates numeric value that can be either absolute or relative

items[].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.

items[].updatePolicy.maxUnavailable.fixed INTEGER

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

items[].updatePolicy.maxUnavailable.percent INTEGER

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

items[].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

items[].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)

items[].versions[] OBJECT

items[].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

items[].versions[].name STRING

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

items[].versions[].targetSize OBJECT

Encapsulates numeric value that can be either absolute or relative

items[].zone STRING

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

kind STRING

[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups

nextPageToken STRING

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warning.data[] OBJECT

warning.data[].key STRING

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

warning.message STRING

[Output Only] A human-readable description of the warning code