GOgoogle
snapshots

GET /projects/{project}/global/snapshots/{snapshot}

Changed on

Returns the specified Snapshot resource.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/global/snapshots/{snapshot}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

Project ID for this request.

snapshotstring required

Name of the Snapshot resource to return.

Response

Successful response

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

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

autoCreatedboolean

Output only. [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

chainNamestring

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

creationSizeBytesstring int64

Output only. [Output Only] Size in bytes of the snapshot at creation time.

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.

diskSizeGbstring int64

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

downloadBytesstring int64

Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

enableConfidentialComputeboolean

Output only. Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

guestFlushboolean

[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.

idstring uint64

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

kindstring

Output only. [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

labelFingerprintstring byte

A fingerprint for the labels being applied to this snapshot, 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 snapshot.

labelsobject

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

licenseCodesstring[]

Output only. [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

licensesstring[]

Output only. [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

locationHintstring

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

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.

regionstring

Output only. [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

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

selfLinkstring

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

snapshotGroupIdstring

Output only. [Output Only] The unique ID of the snapshot group that this snapshot belongs to. The usage of snapshot group feature is restricted.

snapshotGroupNamestring

Output only. [Output only] The snapshot group that this snapshot belongs to. The usage of snapshot group feature is restricted.

snapshotType'ARCHIVE' | 'STANDARD'

Indicates the type of the snapshot. Valid values are ARCHIVE or STANDARD. The default is STANDARD.

sourceDiskstring

The source disk used to create this snapshot.

sourceDiskForRecoveryCheckpointstring

The source disk whose recovery checkpoint will be used to create this snapshot.

sourceDiskIdstring

Output only. [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

sourceInstantSnapshotstring

The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

 - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
 - projects/project/zones/zone/instantSnapshots/instantSnapshot
  • zones/zone/instantSnapshots/instantSnapshot
sourceInstantSnapshotIdstring

Output only. [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

sourceSnapshotSchedulePolicystring

Output only. [Output Only] URL of the resource policy which created this scheduled snapshot.

sourceSnapshotSchedulePolicyIdstring

Output only. [Output Only] ID of the resource policy which created this scheduled snapshot.

status'CREATING' | 'DELETING' | 'FAILED' | 'READY' | 'UPLOADING'

Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.

storageBytesstring int64

Output only. [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

storageBytesStatus'UPDATING' | 'UP_TO_DATE'

Output only. [Deprecated] Instead, check the storageBytes field. After snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE. [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be unset, meaning the snapshot is being created, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

storageLocationsstring[]

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c