instant_snapshots

Creates, updates, deletes, gets or lists an instant_snapshots resource.

Overview

Name	`instant_snapshots`
Type	Resource
Id	`google.compute.instant_snapshots`

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: a-z?)
`architecture`	`string`	[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`diskSizeGb`	`string (int64)`	[Output Only] Size of the source disk, specified in GB.
`kind`	`string`	[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources. (default: compute#instantSnapshot)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
`labels`	`object`	Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
`region`	`string`	[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`resourceStatus`	`object`	[Output Only] Status information for the instant snapshot resource. (id: InstantSnapshotResourceStatus)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	[Output Only] Reserved for future use.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string`	[Output Only] Server-defined URL for this resource's resource id.
`sourceDisk`	`string`	URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
`sourceDiskId`	`string`	[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
`status`	`string`	[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
`zone`	`string`	[Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Successful response

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of InstantSnapshot resources.
`kind`	`string`	Type of resource. (default: compute#instantSnapshotList)
`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.

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: a-z?)
`architecture`	`string`	[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`diskSizeGb`	`string (int64)`	[Output Only] Size of the source disk, specified in GB.
`kind`	`string`	[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources. (default: compute#instantSnapshot)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
`labels`	`object`	Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
`region`	`string`	[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`resourceStatus`	`object`	[Output Only] Status information for the instant snapshot resource. (id: InstantSnapshotResourceStatus)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	[Output Only] Reserved for future use.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string`	[Output Only] Server-defined URL for this resource's resource id.
`sourceDisk`	`string`	URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
`sourceDiskId`	`string`	[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
`status`	`string`	[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
`zone`	`string`	[Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `instantSnapshot`		Returns the specified InstantSnapshot resource in the specified region.
`list`	`select`	`project`, `region`	`filter`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`	Retrieves the list of InstantSnapshot resources contained within the specified region.
`aggregated_list`	`select`	`project`	`filter`, `includeAllScopes`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`, `serviceProjectNumber`	Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`, `region`	`requestId`	Creates an instant snapshot in the specified region.
`delete`	`delete`	`project`, `region`, `instantSnapshot`	`requestId`	Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.
`set_labels`	`exec`	`project`, `region`, `resource`	`requestId`	Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.

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
`instantSnapshot`	`string`
`project`	`string`
`region`	`string`
`resource`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`

`SELECT` examples

get
list
aggregated_list

Returns the specified InstantSnapshot resource in the specified region.

SELECT
id,
name,
architecture,
creationTimestamp,
description,
diskSizeGb,
kind,
labelFingerprint,
labels,
region,
resourceStatus,
satisfiesPzi,
satisfiesPzs,
selfLink,
selfLinkWithId,
sourceDisk,
sourceDiskId,
status,
zone
FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND instantSnapshot = '{{ instantSnapshot }}' -- required;

Retrieves the list of InstantSnapshot resources contained within the specified region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
architecture,
creationTimestamp,
description,
diskSizeGb,
kind,
labelFingerprint,
labels,
region,
resourceStatus,
satisfiesPzi,
satisfiesPzs,
selfLink,
selfLinkWithId,
sourceDisk,
sourceDiskId,
status,
zone
FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';

`INSERT` examples

insert
Manifest

Creates an instant snapshot in the specified region.

INSERT INTO google.compute.instant_snapshots (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__status,
data__sourceDisk,
data__sourceDiskId,
data__diskSizeGb,
data__selfLink,
data__selfLinkWithId,
data__labels,
data__labelFingerprint,
data__zone,
data__region,
data__satisfiesPzs,
data__architecture,
data__resourceStatus,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ status }}',
'{{ sourceDisk }}',
'{{ sourceDiskId }}',
'{{ diskSizeGb }}',
'{{ selfLink }}',
'{{ selfLinkWithId }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ zone }}',
'{{ region }}',
{{ satisfiesPzs }},
'{{ architecture }}',
'{{ resourceStatus }}',
'{{ project }}',
'{{ region }}',
'{{ 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: instant_snapshots
  props:
    - name: project
      value: string
      description: Required parameter for the instant_snapshots resource.
    - name: region
      value: string
      description: Required parameter for the instant_snapshots resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
        
      default: compute#instantSnapshot
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: status
      value: string
      description: >
        [Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
        
      valid_values: ['CREATING', 'DELETING', 'FAILED', 'READY', 'UNAVAILABLE']
    - name: sourceDisk
      value: string
      description: >
        URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk 
        
    - name: sourceDiskId
      value: string
      description: >
        [Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
        
    - name: diskSizeGb
      value: string
      description: >
        [Output Only] Size of the source disk, specified in GB.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: selfLinkWithId
      value: string
      description: >
        [Output Only] Server-defined URL for this resource's resource id.
        
    - name: labels
      value: object
      description: >
        Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
        
    - name: labelFingerprint
      value: string
      description: >
        A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
        
    - name: zone
      value: string
      description: >
        [Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        
    - name: region
      value: string
      description: >
        [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        
    - name: satisfiesPzs
      value: boolean
      description: >
        [Output Only] Reserved for future use.
        
    - name: architecture
      value: string
      description: >
        [Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
        
      valid_values: ['ARCHITECTURE_UNSPECIFIED', 'ARM64', 'X86_64']
    - name: resourceStatus
      value: object
      description: >
        [Output Only] Status information for the instant snapshot resource.
        
    - name: requestId
      value: string

`DELETE` examples

delete

Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.

DELETE FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND instantSnapshot = '{{ instantSnapshot }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

set_labels

Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.

EXEC google.compute.instant_snapshots.set_labels 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@resource='{{ resource }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​

Overview

Fields

Methods

Parameters

`SELECT` examples

`INSERT` examples

`DELETE` examples

Lifecycle Methods