RegionInstanceGroupManagers: listManagedInstances

Requires authorization

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

Request

HTTP request

POST https://www.googleapis.com/compute/beta/projects/project/regions/region/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.
region string Name of the region scoping this request.
Optional query parameters
filter string
maxResults unsigned integer
order_by string
pageToken string

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 List of managed instances.
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.

Send feedback about...

Compute Engine