Method: regionInstanceGroupManagerResizeRequests.get

Returns all of the details about the specified resize request.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

The name of the region scoping this request. Name should conform to RFC1035.
instanceGroupManager

string

The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.

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

  • compute.instanceGroupManagers.get
resizeRequest

string

The name of the resize request. Name should conform to RFC1035 or be a resource ID.

Request body

The request body must be empty.

Response body

InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.

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

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "zone": string,
  "region": string,
  "count": integer,
  "resizeBy": integer,
  "requestedRunDuration": {
    "seconds": string,
    "nanos": integer
  },
  "state": enum,
  "status": {
    "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.
            }
          ]
        }
      ]
    },
    "lastAttempt": {
      "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
                }
              }
            ]
          }
        ]
      }
    }
  },
  "selfLink": string,
  "selfLinkWithId": string
}
Fields
kind

string

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

string (uint64 format)

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

string

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

string

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

string

An optional description of this resource.
zone

string

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

string

[Output Only] The URL of a region where the resize request is located. Populated only for regional resize requests.
count
(deprecated)

integer

This field is deprecated, please use resizeBy instead. The count of instances to create as part of this resize request.
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'.
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.
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
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.
state

enum

[Output only] Current state of the request.
status

object

[Output only] Status of the request.
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.
status.error.errors[]

object

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

string

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

string

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

string

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

object
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.
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".
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.
status.error.errors[].errorDetails[].quotaInfo

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

string

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

string

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

map (key: string, value: string)

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

number

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

number

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

enum

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

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

object

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

string

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

string

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

object
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"
status.error.errors[].errorDetails[].localizedMessage.message

string

The localized error message in the above locale.
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.
status.lastAttempt.error

object

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

object

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

string

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

string

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

string

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

object
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.
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".
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.
status.lastAttempt.error.errors[].errorDetails[].quotaInfo

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

string

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

string

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

map (key: string, value: string)

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

number

Current effective quota limit. The limit's unit depends on the quota type or metric.
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.
status.lastAttempt.error.errors[].errorDetails[].quotaInfo.rolloutStatus

enum

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

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

object

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

string

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

string

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

object
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"
status.lastAttempt.error.errors[].errorDetails[].localizedMessage.message

string

The localized error message in the above locale.

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.