Method: instanceGroupManagers.listManagedInstances

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/listManagedInstances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
zone

string

The name of the zone where the managed instance group is located.
resourceId

string

The name of the managed instance group.

Authorization requires the following IAM permission on the specified resource instanceGroupManager:

  • compute.instanceGroupManagers.get

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 
{
  "managedInstances": [
    {
      "instance": string,
      "id": string,
      "instanceStatus": enum,
      "version": {
        "name": string,
        "instanceTemplate": string
      },
      "preservedStateFromPolicy": {
        "disks": {
          string: {
            object(PreservedDisk)
          },
          ...
        },
        "metadata": {
          string: string,
          ...
        }
      },
      "preservedStateFromConfig": {
        "disks": {
          string: {
            object(PreservedDisk)
          },
          ...
        },
        "metadata": {
          string: string,
          ...
        }
      },
      "currentAction": enum,
      "instanceHealth": [
        {
          "healthCheck": string,
          "detailedHealthState": enum
        }
      ],
      "lastAttempt": {
        "errors": {
          "errors": [
            {
              "code": string,
              "location": string,
              "message": string
            }
          ]
        }
      }
    }
  ],
  "nextPageToken": string
}
Fields
managedInstances[]

object

[Output Only] The list of instances in the managed instance group.
managedInstances[].instance

string

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
managedInstances[].id

string (fixed64 format)

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.
managedInstances[].instanceStatus

enum

[Output Only] The status of the instance. This field is empty when the instance does not exist.
managedInstances[].version

object

[Output Only] Intended version of this instance.
managedInstances[].version.name

string

[Output Only] Name of the version.
managedInstances[].version.instanceTemplate

string

[Output Only] The intended template of the instance. This field is empty when currentAction is one of { DELETING, ABANDONING }.
managedInstances[].preservedStateFromPolicy

object

[Output Only] Preserved state generated based on stateful policy for this instance.
managedInstances[].preservedStateFromPolicy.disks

map (key: string, value: object)

Preserved disks defined for this instance. 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" }.
managedInstances[].preservedStateFromPolicy.metadata

map (key: string, value: string)

Preserved metadata defined for this instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
managedInstances[].preservedStateFromConfig

object

[Output Only] Preserved state applied from per-instance config for this instance.
managedInstances[].preservedStateFromConfig.disks

map (key: string, value: object)

Preserved disks defined for this instance. 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" }.
managedInstances[].preservedStateFromConfig.metadata

map (key: string, value: string)

Preserved metadata defined for this instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
managedInstances[].currentAction

enum

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:

  • NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
  • CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
  • CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
  • RECREATING The managed instance group is recreating this instance.
  • DELETING The managed instance group is permanently deleting this instance.
  • ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
  • RESTARTING The managed instance group is restarting the instance.
  • REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
  • VERIFYING The managed instance group has created the instance and it is in the process of being verified.
managedInstances[].instanceHealth[]

object

[Output Only] Health state of the instance per health-check.
managedInstances[].instanceHealth[].healthCheck

string

[Output Only] The URL for the health check that verifies whether the instance is healthy.
managedInstances[].instanceHealth[].detailedHealthState

enum

[Output Only] The current detailed instance health state.
managedInstances[].lastAttempt

object

[Output Only] Information about the last attempt to create or delete the instance.
managedInstances[].lastAttempt.errors

object

[Output Only] Encountered errors during the last attempt to create or delete the instance.
managedInstances[].lastAttempt.errors.errors[]

object

[Output Only] The array of errors encountered while processing this operation.
managedInstances[].lastAttempt.errors.errors[].code

string

[Output Only] The error type identifier for this error.
managedInstances[].lastAttempt.errors.errors[].location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.
managedInstances[].lastAttempt.errors.errors[].message

string

[Output Only] An optional, human-readable error message.
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.

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.