Method: instanceGroupManagers.aggregatedList

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

HTTP request

GET https://compute.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

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.

returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

includeAllScopes

boolean

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

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": {
    string: {
      "instanceGroupManagers": [
        {
          "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
              }
            }
          ],
          "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": {
                string: {
                  "autoDelete": enum
                },
                ...
              }
            }
          },
          "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
      }
    ]
  },
  "unreachables": [
    string
  ],
  "kind": string
}
Fields
id

string

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

items

map (key: string, value: object)

A list of InstanceGroupManagersScopedList resources.

Key: [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 (uint64 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.

items.instanceGroupManagers[].zone

string

[Output Only] The URL of a 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 the intended distribution of managed instances across zones in a regional managed instance group.

items.instanceGroupManagers[].distributionPolicy.zones[]

object

Zones where the regional managed instance group will create and manage its 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[].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.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. 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.instanceGroupManagers[].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.instanceGroupManagers[].versions[].name

string

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

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