instance_group_manager_resize_requests
Creates, updates, deletes, gets or lists an instance_group_manager_resize_requests
resource.
Overview
Name | instance_group_manager_resize_requests |
Type | Resource |
Id | google.compute.instance_group_manager_resize_requests |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Successful response
Name | Datatype | Description |
---|---|---|
id | string (uint64) | [Output Only] A unique identifier for this resource type. The server generates this identifier. |
name | string | The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035. (pattern: a-z?) |
creationTimestamp | string | [Output Only] The creation timestamp for this resize request in RFC3339 text format. |
description | string | An optional description of this resource. |
kind | string | [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests. (default: compute#instanceGroupManagerResizeRequest) |
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. (id: Duration) |
resizeBy | integer (int32) | 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'. |
selfLink | string | [Output Only] The URL for this resize request. The server defines this URL. |
selfLinkWithId | string | [Output Only] Server-defined URL for this resource with the resource id. |
state | string | [Output only] Current state of the request. |
status | object | [Output only] Status of the request. (id: InstanceGroupManagerResizeRequestStatus) |
zone | string | [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests. |
Successful response
Name | Datatype | Description |
---|---|---|
id | string | [Output Only] Unique identifier for the resource; defined by the server. |
items | array | A list of resize request resources. |
kind | string | [Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests. (default: compute#instanceGroupManagerResizeRequestList) |
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. |
selfLink | string | [Output Only] Server-defined URL for this resource. |
warning | object | [Output Only] Informational warning message. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | project , zone , instanceGroupManager , resizeRequest | Returns all of the details about the specified resize request. | |
list | select | project , zone , instanceGroupManager | filter , maxResults , orderBy , pageToken , returnPartialSuccess | Retrieves a list of resize requests that are contained in the managed instance group. |
insert | insert | project , zone , instanceGroupManager | requestId | Creates a new resize request that starts provisioning VMs immediately or queues VM creation. |
delete | delete | project , zone , instanceGroupManager , resizeRequest | requestId | Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. |
cancel | exec | project , zone , instanceGroupManager , resizeRequest | requestId | Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
instanceGroupManager | string | |
project | string | |
resizeRequest | string | |
zone | string | |
filter | string | |
maxResults | integer (uint32) | |
orderBy | string | |
pageToken | string | |
requestId | string | |
returnPartialSuccess | boolean |
SELECT
examples
- get
- list
Returns all of the details about the specified resize request.
SELECT
id,
name,
creationTimestamp,
description,
kind,
requestedRunDuration,
resizeBy,
selfLink,
selfLinkWithId,
state,
status,
zone
FROM google.compute.instance_group_manager_resize_requests
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND instanceGroupManager = '{{ instanceGroupManager }}' -- required
AND resizeRequest = '{{ resizeRequest }}' -- required;
Retrieves a list of resize requests that are contained in the managed instance group.
SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.instance_group_manager_resize_requests
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND instanceGroupManager = '{{ instanceGroupManager }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';
INSERT
examples
- insert
- Manifest
Creates a new resize request that starts provisioning VMs immediately or queues VM creation.
INSERT INTO google.compute.instance_group_manager_resize_requests (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__zone,
data__resizeBy,
data__requestedRunDuration,
data__state,
data__status,
data__selfLink,
data__selfLinkWithId,
project,
zone,
instanceGroupManager,
requestId
)
SELECT
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ zone }}',
{{ resizeBy }},
'{{ requestedRunDuration }}',
'{{ state }}',
'{{ status }}',
'{{ selfLink }}',
'{{ selfLinkWithId }}',
'{{ project }}',
'{{ zone }}',
'{{ instanceGroupManager }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;
# Description fields are for documentation purposes
- name: instance_group_manager_resize_requests
props:
- name: project
value: string
description: Required parameter for the instance_group_manager_resize_requests resource.
- name: zone
value: string
description: Required parameter for the instance_group_manager_resize_requests resource.
- name: instanceGroupManager
value: string
description: Required parameter for the instance_group_manager_resize_requests resource.
- name: kind
value: string
description: >
[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
default: compute#instanceGroupManagerResizeRequest
- name: id
value: string
description: >
[Output Only] A unique identifier for this resource type. The server generates this identifier.
- name: creationTimestamp
value: string
description: >
[Output Only] The creation timestamp for this resize request in RFC3339 text format.
- name: name
value: string
description: >
The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
- name: description
value: string
description: >
An optional description of this resource.
- name: zone
value: string
description: >
[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
- name: resizeBy
value: integer
description: >
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'.
- name: requestedRunDuration
value: object
description: >
Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
- name: state
value: string
description: >
[Output only] Current state of the request.
valid_values: ['ACCEPTED', 'CANCELLED', 'CREATING', 'FAILED', 'STATE_UNSPECIFIED', 'SUCCEEDED']
- name: status
value: object
description: >
[Output only] Status of the request.
- name: selfLink
value: string
description: >
[Output Only] The URL for this resize request. The server defines this URL.
- name: selfLinkWithId
value: string
description: >
[Output Only] Server-defined URL for this resource with the resource id.
- name: requestId
value: string
DELETE
examples
- delete
Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
DELETE FROM google.compute.instance_group_manager_resize_requests
WHERE project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND instanceGroupManager = '{{ instanceGroupManager }}' --required
AND resizeRequest = '{{ resizeRequest }}' --required
AND requestId = '{{ requestId }}';
Lifecycle Methods
- cancel
Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue.
EXEC google.compute.instance_group_manager_resize_requests.cancel
@project='{{ project }}' --required,
@zone='{{ zone }}' --required,
@instanceGroupManager='{{ instanceGroupManager }}' --required,
@resizeRequest='{{ resizeRequest }}' --required,
@requestId='{{ requestId }}';