InstanceGroupManagers: listManagedInstances

Requires authorization

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.

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/zones/zone/instanceGroupManagers/instanceGroupManager/listManagedInstances

Parameters

Parameter name Value Description
Path parameters
instanceGroupManager string The name of the managed instance group.
project string Project ID for this request.
zone string The name of the zone where the managed instance group is located.
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)
order_by 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:

{
  "managedInstances": [
    {
      "instance": string,
      "id": unsigned long,
      "instanceStatus": string,
      "currentAction": string,
      "lastAttempt": {
        "errors": {
          "errors": [
            {
              "code": string,
              "location": string,
              "message": string
            }
          ]
        }
      }
    }
  ]
}
Property name Value Description Notes
managedInstances[] list [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 unsigned long [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
managedInstances[].instanceStatus string [Output Only] The status of the instance. This field is empty when the instance does not exist.
managedInstances[].currentAction string [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.
managedInstances[].lastAttempt nested 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[] list [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.

Monitor your resources on the go

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

Send feedback about...

Compute Engine