- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of managed instance groups that are contained within the specified region.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
region
|
Name of the region scoping this request. |
Query parameters
Parameters | |
---|---|
maxResults
|
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken
|
Specifies a page token to use. Set |
filter
|
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy
|
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 Currently, only sorting by |
returnPartialSuccess
|
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
Contains a list of managed instance groups.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "items" : [ { "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 } , "targetSize" : integer , "listManagedInstancesResults" : 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 } , "satisfiesPzi" : boolean , "satisfiesPzs" : boolean } ] , "nextPageToken" : string , "selfLink" : string , "warning" : { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } } |
kind
string
[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
id
string
[Output Only] Unique identifier for the resource; defined by the server.
items[]
object
A list of InstanceGroupManager resources.
items[].kind
string
[Output Only] The resource type, which is always compute#instanceGroupManager
for managed instance groups.
items[].id
string ( uint64
format)
[Output Only] A unique identifier for this resource type. The server generates this identifier.
items[].creationTimestamp
string
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
items[].name
string
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035 .
items[].description
string
An optional description of this resource.
items[].zone
string
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
items[].region
string
[Output Only] The URL of the region where the managed instance group resides (for regional resources).
items[].distributionPolicy
object
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
items[].distributionPolicy.zones[]
object
Zones where the regional managed instance group will create and manage its instances.
items[].distributionPolicy.zones[].zone
string
The URL of the zone . The zone must exist in the region where the managed instance group is located.
items[].distributionPolicy.targetShape
enum
The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType
).
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. 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
.
items[].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
.
items[].versions[].name
string
Name of the version. Unique among all versions in the scope of this managed instance group.
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. 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.
items[].versions[].targetSize
object
Specifies the intended number of instances to be created from the instanceTemplate
. The final number of instances created from the template will be equal to:
- If expressed as a fixed number, the minimum of either
targetSize.fixed
orinstanceGroupManager.targetSize
is used. - if expressed as a
percent
, thetargetSize
would be(targetSize.percent/100 * InstanceGroupManager.targetSize)
If there is a remainder, the number is rounded.
version
. Read Starting a canary update
for more information.items[].versions[].targetSize.fixed
integer
Specifies a fixed number of VM instances. This must be a positive integer.
items[].versions[].targetSize.percent
integer
Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80
for 80%.
items[].versions[].targetSize.calculated
integer
[Output Only] Absolute value of VM instances calculated based on the specific mode.
- If the value is
fixed
, then thecalculated
value is equal to thefixed
value. - If the value is a
percent
, then thecalculated
value ispercent
/100 *targetSize
. For example, thecalculated
value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
items[].allInstancesConfig
object
Specifies configuration that overrides the instance template configuration for the group.
items[].allInstancesConfig.properties
object
Properties to set on all instances in the group.
You can add or modify properties using the instanceGroupManagers.patch
or regionInstanceGroupManagers.patch
. After setting allInstancesConfig
on the group, you must update the group's instances to apply the configuration. To apply the configuration, set the group's updatePolicy.type
field to use proactive updates or use the applyUpdatesToInstances
method.
items[].allInstancesConfig.properties.metadata
map (key: string, value: string)
The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata .
items[].allInstancesConfig.properties.labels
map (key: string, value: string)
The label key-value pairs that you want to patch onto the instance.
items[].instanceGroup
string
[Output Only] The URL of the Instance Group resource.
items[].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.
items[].baseInstanceName
string
The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format.
When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\[[0-9]{1,10}\])?))
items[].fingerprint
string ( bytes
format)
Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet
.
To see the latest fingerprint, make a get()
request to retrieve an InstanceGroupManager.
A base64-encoded string.
items[].currentActions
object
[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
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.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.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[].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.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.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.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.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.suspending
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.
items[].currentActions.resuming
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.
items[].currentActions.stopping
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.
items[].currentActions.starting
integer
[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.
items[].status
object
[Output Only] The status of this managed instance group.
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[].status.allInstancesConfig
object
[Output only] Status of all-instances configuration on the group.
items[].status.allInstancesConfig.effective
boolean
[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.
items[].status.allInstancesConfig.currentRevision
string
[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.
items[].status.versionTarget
object
[Output Only] A status of consistency of Instances' versions with their target version specified by version
field on Instance Group Manager.
items[].status.versionTarget.isReached
boolean
[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version
field on Instance Group Manager.
items[].status.stateful
object
[Output Only] Stateful status of the given Instance Group Manager.
items[].status.stateful.hasStatefulConfig
boolean
[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
items[].status.stateful.perInstanceConfigs
object
[Output Only] Status of per-instance configurations on the instances.
items[].status.stateful.perInstanceConfigs.allEffective
boolean
A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE
or there are no per-instance-configs.
items[].status.autoscaler
string
[Output Only] The URL of the Autoscaler that targets this instance group manager.
items[].targetSize
integer
The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
items[].listManagedInstancesResults
enum
Pagination behavior of the listManagedInstances
API method for this managed instance group.
items[].selfLink
string
[Output Only] The URL for this managed instance group. The server defines this URL.
items[].autoHealingPolicies[]
object
The autohealing policy for this managed instance group. You can specify only one value.
items[].autoHealingPolicies[].healthCheck
string
The URL for the health check that signals autohealing.
items[].autoHealingPolicies[].initialDelaySec
integer
The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.
items[].updatePolicy
object
The update policy for this managed instance group.
items[].updatePolicy.type
enum
The type of update process
. You can specify either PROACTIVE
so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC
so that you can select the VMs that you want to update.
items[].updatePolicy.instanceRedistributionType
enum
The instance redistribution policy for regional managed instance groups. Valid values are:
-
PROACTIVE
(default): The group attempts to maintain an even distribution of VM instances across zones in the region. -
NONE
: For non-autoscaled groups, proactive redistribution is disabled.
items[].updatePolicy.minimalAction
enum
Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary.
- To limit disruption as much as possible, set the minimal action to
REFRESH
. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to
RESTART
orREPLACE
. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action toRESTART
in order to pick up metadata changes.
items[].updatePolicy.mostDisruptiveAllowedAction
enum
Most disruptive action that is allowed to be taken on an instance. You can specify either NONE
to forbid any actions, REFRESH
to avoid restarting the VM and to limit disruption as much as possible. RESTART
to allow actions that can be applied without instance replacing or REPLACE
to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
items[].updatePolicy.maxSurge
object
The maximum number of instances that can be created above the specified targetSize
during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge
is a fixed value equal to the number of zones in which the managed instance group operates.
At least one of either maxSurge
or maxUnavailable
must be greater than 0. Learn more about maxSurge
.
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.maxSurge.calculated
integer
[Output Only] Absolute value of VM instances calculated based on the specific mode.
- If the value is
fixed
, then thecalculated
value is equal to thefixed
value. - If the value is a
percent
, then thecalculated
value ispercent
/100 *targetSize
. For example, thecalculated
value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
items[].updatePolicy.maxUnavailable
object
The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
- The instance's status
is
RUNNING
. - If there is a health
check
on the instance group, the instance's health check status
must be
HEALTHY
at least once. If there is no health check on the group, then the instance only needs to have a status ofRUNNING
to be considered available.
This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable
is a fixed value equal to the number of zones in which the managed instance group operates.
At least one of either maxSurge
or maxUnavailable
must be greater than 0. Learn more about maxUnavailable
.
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.maxUnavailable.calculated
integer
[Output Only] Absolute value of VM instances calculated based on the specific mode.
- If the value is
fixed
, then thecalculated
value is equal to thefixed
value. - If the value is a
percent
, then thecalculated
value ispercent
/100 *targetSize
. For example, thecalculated
value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
items[].updatePolicy.replacementMethod
enum
What action should be used to replace instances. See minimalAction.REPLACE
items[].namedPorts[]
object
Named ports configured for the Instance Groups complementary to this Instance Group Manager.
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[].statefulPolicy
object
Stateful configuration for this Instanced Group Manager
items[].statefulPolicy.preservedState
object
items[].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.
items[].statefulPolicy.preservedState.disks[].autoDelete
enum
These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY
mode cannot be auto-deleted.
items[].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.
items[].statefulPolicy.preservedState.internalIPs[].autoDelete
enum
These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.
items[].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.
items[].statefulPolicy.preservedState.externalIPs[].autoDelete
enum
These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.
items[].instanceLifecyclePolicy
object
The repair policy for this managed instance group.
items[].instanceLifecyclePolicy.forceUpdateOnRepair
enum
A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are:
- NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy.
- YES: If configuration updates are available, they are applied during repair.
items[].instanceLifecyclePolicy.defaultActionOnFailure
enum
The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are
-
REPAIR
(default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG . -
DO_NOTHING
: MIG does not repair a failed or an unhealthy VM.
items[].satisfiesPzi
boolean
[Output Only] Reserved for future use.
items[].satisfiesPzs
boolean
[Output Only] Reserved for future use.
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
enum
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE
if there are no results in the response.
warning.message
string
[Output Only] A human-readable description of the warning code.
warning.data[]
object
[Output Only] Metadata about this warning in key: value
format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
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.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute.readonly
-
https://www.googleapis.com/auth/compute
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
-
compute.instanceGroupManagers.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .