InstanceGroupManagers: aggregatedList

Requires authorization

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

Request

HTTP request

GET https://www.googleapis.com/compute/beta/projects/project/aggregated/instanceGroupManagers

Parameters

Parameter name Value Description
Path parameters
project string Project ID for this request.
Optional query parameters
filter string Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResults unsigned 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.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#instanceGroupManagerAggregatedList",
  "id": string,
  "items": {
    (key): {
      "instanceGroupManagers": [
        {
          "kind": "compute#instanceGroupManager",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "zone": string,
          "region": string,
          "instanceTemplate": string,
          "instanceGroup": string,
          "targetPools": [
            string
          ],
          "baseInstanceName": string,
          "fingerprint": bytes,
          "currentActions": {
            "none": integer,
            "creating": integer,
            "creatingWithoutRetries": integer,
            "recreating": integer,
            "deleting": integer,
            "abandoning": integer,
            "restarting": integer,
            "refreshing": integer
          },
          "targetSize": integer,
          "selfLink": string,
          "autoHealingPolicies": [
            {
              "healthCheck": string,
              "initialDelaySec": integer
            }
          ],
          "namedPorts": [
            {
              "name": string,
              "port": integer
            }
          ],
          "serviceAccount": string,
          "failoverAction": string
        }
      ],
      "warning": {
        "code": string,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    }
  },
  "nextPageToken": string,
  "selfLink": string
}
Property name Value Description Notes
kind string [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
id string [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
items object [Output Only] A map of filtered managed instance group lists.
items.(key) nested object [Output Only] The name of the scope that contains this set of managed instance groups.
items.(key).instanceGroupManagers[] list [Output Only] The list of managed instance groups that are contained in the specified project and zone.
items.(key).warning object [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
items.(key).warning.code string [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.(key).warning.message string [Output Only] A human-readable description of the warning code.
items.(key).warning.data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.(key).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.(key).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.
items.(key).instanceGroupManagers[].kind string [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
items.(key).instanceGroupManagers[].id unsigned long [Output Only] A unique identifier for this resource type. The server generates this identifier.
items.(key).instanceGroupManagers[].creationTimestamp string [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
items.(key).instanceGroupManagers[].zone string [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
items.(key).instanceGroupManagers[].name string The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
items.(key).instanceGroupManagers[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).instanceGroupManagers[].region string [Output Only] The URL of the region where the managed instance group resides (for regional resources).
items.(key).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.(key).instanceGroupManagers[].instanceGroup string [Output Only] The URL of the Instance Group resource.
items.(key).instanceGroupManagers[].targetPools[] list 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.(key).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.(key).instanceGroupManagers[].fingerprint bytes [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
items.(key).instanceGroupManagers[].currentActions nested 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.(key).instanceGroupManagers[].currentActions.none integer [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
items.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].autoHealingPolicies[] list The autohealing policy for this managed instance group. You can specify only one value.
items.(key).instanceGroupManagers[].autoHealingPolicies[].healthCheck string The URL for the health check that signals autohealing.
items.(key).instanceGroupManagers[].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.(key).instanceGroupManagers[].namedPorts[] list Named ports configured for the Instance Groups complementary to this Instance Group Manager.
items.(key).instanceGroupManagers[].namedPorts[].name string The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
items.(key).instanceGroupManagers[].namedPorts[].port integer The port number, which can be a value between 1 and 65535.
items.(key).instanceGroupManagers[].failoverAction string The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
items.(key).instanceGroupManagers[].serviceAccount string Service account will be used as credentials for all operations performed by managed instance group on instances. The service accounts needs all permissions required to create and delete instances. When not specified, the service account {projectNumber}@cloudservices.gserviceaccount.com will be used.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine