Method: instanceGroupManagerResizeRequests.list

Retrieves a list of resize requests that are contained in the managed instance group.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

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. The name should conform to RFC1035.
instanceGroupManager

string

The name of the managed instance group. The name should conform to RFC1035.

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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

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)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
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.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

[Output Only] A list of resize requests.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "zone": string,
      "resizeBy": integer,
      "requestedRunDuration": {
        "seconds": string,
        "nanos": integer
      },
      "state": enum,
      "status": {
        "error": {
          "errors": [
            {
              "code": string,
              "location": string,
              "message": string,
              "errorDetails": [
                {
                  "errorInfo": {
                    "reason": string,
                    "domain": string,
                    "metadatas": {
                      string: string,
                      ...
                    }
                  },
                  "quotaInfo": {
                    "metricName": string,
                    "limitName": string,
                    "dimensions": {
                      string: string,
                      ...
                    },
                    "limit": number,
                    "futureLimit": number,
                    "rolloutStatus": enum
                  },
                  "help": {
                    "links": [
                      {
                        "description": string,
                        "url": string
                      }
                    ]
                  },
                  "localizedMessage": {
                    "locale": string,
                    "message": string
                  }
                }
              ]
            }
          ]
        },
        "lastAttempt": {
          "error": {
            "errors": [
              {
                "code": string,
                "location": string,
                "message": string,
                "errorDetails": [
                  {

                    // Union field details_oneof can be only one of the following:
                    "errorInfo": {
                      "reason": string,
                      "domain": string,
                      "metadatas": {
                        string: string,
                        ...
                      }
                    },
                    "quotaInfo": {
                      "metricName": string,
                      "limitName": string,
                      "dimensions": {
                        string: string,
                        ...
                      },
                      "limit": number,
                      "futureLimit": number,
                      "rolloutStatus": enum
                    },
                    "help": {
                      "links": [
                        {
                          "description": string,
                          "url": string
                        }
                      ]
                    },
                    "localizedMessage": {
                      "locale": string,
                      "message": string
                    }
                    // End of list of possible types for union field details_oneof.
                  }
                ]
              }
            ]
          }
        }
      },
      "selfLink": string,
      "selfLinkWithId": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items[]

object

A list of resize request resources.
items[].kind

string

[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
items[].id

string (uint64 format)

[Output Only] A unique identifier for this resource type. The server generates this identifier.
items[].creationTimestamp

string

[Output Only] The creation timestamp for this resize request in RFC3339 text format.
items[].name

string

The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
items[].description

string

An optional description of this resource.
items[].zone

string

[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
items[].resizeBy

integer

The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.
items[].requestedRunDuration

object

Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
items[].requestedRunDuration.seconds

string (int64 format)

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
items[].requestedRunDuration.nanos

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
items[].state

enum

[Output only] Current state of the request.
items[].status

object

[Output only] Status of the request.
items[].status.error

object

[Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the lastAttempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
items[].status.error.errors[]

object

[Output Only] The array of errors encountered while processing this operation.
items[].status.error.errors[].code

string

[Output Only] The error type identifier for this error.
items[].status.error.errors[].location

string

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

string

[Output Only] An optional, human-readable error message.
items[].status.error.errors[].errorDetails[]

object

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
items[].status.error.errors[].errorDetails[].errorInfo

object
items[].status.error.errors[].errorDetails[].errorInfo.reason

string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
items[].status.error.errors[].errorDetails[].errorInfo.domain

string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
items[].status.error.errors[].errorDetails[].errorInfo.metadatas

map (key: string, value: string)

Additional structured details about this error.

Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
items[].status.error.errors[].errorDetails[].quotaInfo

object
items[].status.error.errors[].errorDetails[].quotaInfo.metricName

string

The Compute Engine quota metric name.
items[].status.error.errors[].errorDetails[].quotaInfo.limitName

string

The name of the quota limit.
items[].status.error.errors[].errorDetails[].quotaInfo.dimensions

map (key: string, value: string)

The map holding related quota dimensions.
items[].status.error.errors[].errorDetails[].quotaInfo.limit

number

Current effective quota limit. The limit's unit depends on the quota type or metric.
items[].status.error.errors[].errorDetails[].quotaInfo.futureLimit

number

Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
items[].status.error.errors[].errorDetails[].quotaInfo.rolloutStatus

enum

Rollout status of the future quota limit.
items[].status.error.errors[].errorDetails[].help

object
items[].status.error.errors[].errorDetails[].help.links[]

object

URL(s) pointing to additional information on handling the current error.
items[].status.error.errors[].errorDetails[].help.links[].description

string

Describes what the link offers.
items[].status.error.errors[].errorDetails[].help.links[].url

string

The URL of the link.
items[].status.error.errors[].errorDetails[].localizedMessage

object
items[].status.error.errors[].errorDetails[].localizedMessage.locale

string

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
items[].status.error.errors[].errorDetails[].localizedMessage.message

string

The localized error message in the above locale.
items[].status.lastAttempt

object

[Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
items[].status.lastAttempt.error

object

Errors that prevented the ResizeRequest to be fulfilled.
items[].status.lastAttempt.error.errors[]

object

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

string

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

string

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

string

[Output Only] An optional, human-readable error message.
items[].status.lastAttempt.error.errors[].errorDetails[]

object

[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
items[].status.lastAttempt.error.errors[].errorDetails[].errorInfo

object
items[].status.lastAttempt.error.errors[].errorDetails[].errorInfo.reason

string

The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
items[].status.lastAttempt.error.errors[].errorDetails[].errorInfo.domain

string

The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
items[].status.lastAttempt.error.errors[].errorDetails[].errorInfo.metadatas

map (key: string, value: string)

Additional structured details about this error.

Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo

object
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo.metricName

string

The Compute Engine quota metric name.
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo.limitName

string

The name of the quota limit.
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo.dimensions

map (key: string, value: string)

The map holding related quota dimensions.
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo.limit

number

Current effective quota limit. The limit's unit depends on the quota type or metric.
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo.futureLimit

number

Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
items[].status.lastAttempt.error.errors[].errorDetails[].quotaInfo.rolloutStatus

enum

Rollout status of the future quota limit.
items[].status.lastAttempt.error.errors[].errorDetails[].help

object
items[].status.lastAttempt.error.errors[].errorDetails[].help.links[]

object

URL(s) pointing to additional information on handling the current error.
items[].status.lastAttempt.error.errors[].errorDetails[].help.links[].description

string

Describes what the link offers.
items[].status.lastAttempt.error.errors[].errorDetails[].help.links[].url

string

The URL of the link.
items[].status.lastAttempt.error.errors[].errorDetails[].localizedMessage

object
items[].status.lastAttempt.error.errors[].errorDetails[].localizedMessage.locale

string

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
items[].status.lastAttempt.error.errors[].errorDetails[].localizedMessage.message

string

The localized error message in the above locale.
items[].selfLink

string

[Output Only] The URL for this resize request. The server defines this URL.
items[].selfLinkWithId

string

[Output Only] Server-defined URL for this resource with the resource id.
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.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
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).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.