Method: regionInstantSnapshots.get

Returns the specified InstantSnapshot resource in the specified region.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

The name of the region for this request.
instantSnapshot

string

Name of the InstantSnapshot resource to return.

Request body

The request body must be empty.

Response body

Represents a InstantSnapshot resource.

You can use instant snapshots to create disk rollback points quickly..

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

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": enum,
  "sourceDisk": string,
  "sourceDiskId": string,
  "diskSizeGb": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "zone": string,
  "region": string,
  "satisfiesPzs": boolean,
  "architecture": enum,
  "resourceStatus": {
    "storageSizeBytes": string
  },
  "satisfiesPzi": boolean
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
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.
description

string

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

enum

[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
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:

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.
diskSizeGb

string (int64 format)

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

map (key: string, value: string)

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

string (bytes format)

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.

A base64-encoded string.
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.
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.
satisfiesPzs

boolean

[Output Only] Reserved for future use.
architecture

enum

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

object

[Output Only] Status information for the instant snapshot resource.
resourceStatus.storageSizeBytes

string (int64 format)

[Output Only] The storage size of this instant snapshot.
satisfiesPzi

boolean

Output only. Reserved for future use.

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.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.instantSnapshots.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.