v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
regionInstantSnapshots

Creates an instant snapshot in the specified region.

post/projects/{project}/regions/{region}/instantSnapshots

Path parameters

projectstring required

Project ID for this request.

regionstring required

Name of the region for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

satisfiesPzsboolean

Output only. [Output Only] Reserved for future use.

namestring

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

diskSizeGbstring int64

Output only. [Output Only] Size of the source disk, specified in GB.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshot for InstantSnapshot resources.

sourceInstantSnapshotGroupstring

Output only. [Output Only] URL of the source instant snapshot this instant snapshot is part of. Note that the source instant snapshot group must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

descriptionstring

An optional description of this resource. Provide this property when you create the resource.

regionstring

Output only. [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.

labelsobject

Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.

labelFingerprintstring 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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.

satisfiesPziboolean

Output only. Reserved for future use.

sourceInstantSnapshotGroupIdstring

Output only. [Output Only] The ID value of the source instant snapshot group this InstantSnapshot is part of. This value may be used to determine whether the InstantSnapshot was created as part of an InstantSnapshotGroup creation.

selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

zonestring

Output only. [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.

architecture'ARCHITECTURE_UNSPECIFIED' | 'ARM64' | 'X86_64'

Output only. [Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.

selfLinkWithIdstring

Output only. [Output Only] Server-defined URL for this resource's resource id.

idstring uint64

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

sourceDiskIdstring

Output only. [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'CREATING' | 'DELETING' | 'FAILED' | 'READY' | 'UNAVAILABLE'

Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY.

sourceDiskstring

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

Response

Successful response