InstanceGroups: aggregatedList

Requires authorization

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


HTTP request



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.


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


Request body

Do not supply a request body with this method.


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

  "kind": "compute#instanceGroupAggregatedList",
  "id": string,
  "items": {
    (key): {
      "instanceGroups": [
          "kind": "compute#instanceGroup",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "namedPorts": [
              "name": string,
              "port": integer
          "network": string,
          "fingerprint": bytes,
          "zone": string,
          "selfLink": string,
          "size": integer,
          "region": string,
          "subnetwork": 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#instanceGroupAggregatedList for aggregated lists of instance groups.
id string [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
items object A map of scoped instance group lists.
items.(key) nested object The name of the scope that contains this set of instance groups.
items.(key).instanceGroups[] list [Output Only] The list of instance groups that are contained in this scope.
items.(key).warning object [Output Only] An informational warning that replaces the list of 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)[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.(key)[].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)[].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).instanceGroups[].kind string [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
items.(key).instanceGroups[].id unsigned long [Output Only] A unique identifier for this instance group, generated by the server.
items.(key).instanceGroups[].creationTimestamp string [Output Only] The creation timestamp for this instance group in RFC3339 text format.
items.(key).instanceGroups[].name string The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
items.(key).instanceGroups[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).instanceGroups[].namedPorts[] list

Assigns a name to a port number. For example: {name: "http", port: 80}

This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Named ports apply to all instances in this instance group.

items.(key).instanceGroups[].namedPorts[].name string The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
items.(key).instanceGroups[].namedPorts[].port integer The port number, which can be a value between 1 and 65535.
items.(key).instanceGroups[].network string The URL of the network to which all instances in the instance group belong.
items.(key).instanceGroups[].fingerprint bytes [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
items.(key).instanceGroups[].zone string [Output Only] The URL of the zone where the instance group is located (for zonal resources).
items.(key).instanceGroups[].size integer [Output Only] The total number of instances in the instance group.
items.(key).instanceGroups[].region string The URL of the region where the instance group is located (for regional resources).
items.(key).instanceGroups[].subnetwork string The URL of the subnetwork to which all instances in the instance group belong.

Send feedback about...

Compute Engine