Method: regionInstanceGroupManagers.list

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

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region scoping this request.

project

string

Project ID for this request.

region

string

Name of the region scoping this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` 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`)
`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.
`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)`
`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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{ "id": string, "items": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "zone": string, "region": string, "distributionPolicy": { "zones": [ { "zone": string } ] }, "instanceTemplate": string, "versions": [ { "name": string, "instanceTemplate": string, "targetSize": { "fixed": integer, "percent": integer, "calculated": integer } } ], "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 }, "status": { "isStable": boolean, "versionTarget": { "isReached": boolean }, "stateful": { "hasStatefulConfig": boolean, "perInstanceConfigs": { "allEffective": boolean } }, "autoscaler": string }, "targetSize": integer, "selfLink": string, "autoHealingPolicies": [ { "healthCheck": string, "initialDelaySec": integer } ], "updatePolicy": { "type": enum, "instanceRedistributionType": enum, "minimalAction": 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": { object } } }, "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string }

JSON representation

{
  "id": string,
  "items": [
    {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "zone": string,
      "region": string,
      "distributionPolicy": {
        "zones": [
          {
            "zone": string
          }
        ]
      },
      "instanceTemplate": string,
      "versions": [
        {
          "name": string,
          "instanceTemplate": string,
          "targetSize": {
            "fixed": integer,
            "percent": integer,
            "calculated": integer
          }
        }
      ],
      "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
      },
      "status": {
        "isStable": boolean,
        "versionTarget": {
          "isReached": boolean
        },
        "stateful": {
          "hasStatefulConfig": boolean,
          "perInstanceConfigs": {
            "allEffective": boolean
          }
        },
        "autoscaler": string
      },
      "targetSize": integer,
      "selfLink": string,
      "autoHealingPolicies": [
        {
          "healthCheck": string,
          "initialDelaySec": integer
        }
      ],
      "updatePolicy": {
        "type": enum,
        "instanceRedistributionType": enum,
        "minimalAction": 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": {
            object
          }
        }
      },
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "kind": string
}

Fields
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of InstanceGroupManager resources.
`items[].id`	`string (fixed64 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. Provide this property when you create the resource.
`items[].zone`	`string` [Output Only] The URL of the 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 intended distribution of instances in regional managed instance group.
`items[].distributionPolicy.zones[]`	`object` Zones where the regional managed instance group will create and manage 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[].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[].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.
`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` 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 up. If unset, this version will update any remaining instances not updated by another `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 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[].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 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[].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[].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.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 config 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 configs on the instance.
`items[].status.stateful.perInstanceConfigs.allEffective`	`boolean` A bit indicating if all of the group's per-instance configs (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[].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 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[].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 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[].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. 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.maxSurge`	`object` The maximum number of instances that can be created above the specified `targetSize` during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. 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 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`	`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 liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. 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 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.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. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`items[].kind`	`string` [Output Only] The resource type, which is always `compute#instanceGroupManager` for 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`	`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.
`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.

Authorization Scopes

Requires one of the following OAuth scopes:

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