Method: instanceGroupManagers.aggregatedList

Retrieves the list of managed instance groups and groups them by zone.

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/aggregated/instanceGroupManagers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

number (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": [
    {
      "scopeName": string,
      "instanceGroupManagers": [
        {
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "zone": string,
          "region": string,
          "distributionPolicy": {
            "zones": [
              {
                "zone": string
              }
            ]
          },
          "instanceTemplate": string,
          "instanceGroup": string,
          "targetPools": [
            string
          ],
          "baseInstanceName": string,
          "fingerprint": string,
          "currentActions": {
            "none": number,
            "creating": number,
            "creatingWithoutRetries": number,
            "verifying": number,
            "recreating": number,
            "deleting": number,
            "abandoning": number,
            "restarting": number,
            "refreshing": number
          },
          "targetSize": number,
          "selfLink": string,
          "namedPorts": [
            {
              "name": string,
              "port": number
            }
          ],
          "kind": string
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": 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 InstanceGroupManagersScopedList resources.

items[].scopeName

string

[Output Only] The name of the scope that contains this set of managed instance groups.

items[].instanceGroupManagers[]

object

[Output Only] The list of managed instance groups that are contained in the specified project and zone.

items[].instanceGroupManagers[].id

string (fixed64 format)

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

items[].instanceGroupManagers[].creationTimestamp

string

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

items[].instanceGroupManagers[].name

string

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

items[].instanceGroupManagers[].description

string

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

items[].instanceGroupManagers[].zone

string

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

items[].instanceGroupManagers[].region

string

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

items[].instanceGroupManagers[].distributionPolicy

object

Policy specifying intended distribution of instances in regional managed instance group.

items[].instanceGroupManagers[].distributionPolicy.zones[]

object

Zones where the regional managed instance group will create and manage instances.

items[].instanceGroupManagers[].distributionPolicy.zones[].zone

string

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

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

string

[Output Only] The URL of the Instance Group resource.

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

To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

A base64-encoded string.

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

number

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

items[].instanceGroupManagers[].currentActions.creating

number

[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[].instanceGroupManagers[].currentActions.creatingWithoutRetries

number

[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[].instanceGroupManagers[].currentActions.verifying

number

[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[].instanceGroupManagers[].currentActions.recreating

number

[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[].instanceGroupManagers[].currentActions.deleting

number

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

items[].instanceGroupManagers[].currentActions.abandoning

number

[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[].instanceGroupManagers[].currentActions.restarting

number

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

items[].instanceGroupManagers[].currentActions.refreshing

number

[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[].instanceGroupManagers[].targetSize

number

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[].instanceGroupManagers[].selfLink

string

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

items[].instanceGroupManagers[].namedPorts[]

object

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

items[].instanceGroupManagers[].namedPorts[].name

string

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

items[].instanceGroupManagers[].namedPorts[].port

number

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

items[].instanceGroupManagers[].kind

string

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

items[].warning

object

[Output Only] The warning that replaces the list of managed instance groups when the list is empty.

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

items[].warning.message

string

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

items[].warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example:

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

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

items[].warning.data[].value

string

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

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.

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#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.

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 Google IAM permissions:

  • compute.instanceGroupManagers.list
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine