- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Returns the specified Snapshot resource. Gets a list of available snapshots by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/snapshots/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
resourceId |
Name of the Snapshot resource to return. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "status": enum, "sourceDisk": string, "sourceDiskId": string, "diskSizeGb": string, "storageBytes": string, "storageBytesStatus": enum, "licenses": [ string ], "snapshotEncryptionKey": { "rawKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceDiskEncryptionKey": { "rawKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "selfLink": string, "labels": { string: string, ... }, "labelFingerprint": string, "licenseCodes": [ string ], "storageLocations": [ string ], "autoCreated": boolean, "downloadBytes": string, "chainName": string, "satisfiesPzs": boolean, "locationHint": string, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
status |
[Output Only] The status of the snapshot. This can be |
sourceDisk |
The source disk used to create this snapshot. |
sourceDiskId |
[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. |
diskSizeGb |
[Output Only] Size of the source disk, specified in GB. |
storageBytes |
[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 |
[Output Only] An indicator whether |
licenses[] |
[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). |
snapshotEncryptionKey |
Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. |
snapshotEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
snapshotEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
snapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
snapshotEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
sourceDiskEncryptionKey |
The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. |
sourceDiskEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
sourceDiskEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
sourceDiskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
sourceDiskEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
selfLink |
[Output Only] Server-defined URL for the resource. |
labels |
Labels to apply to this snapshot. These can be later modified by the An object containing a list of |
labelFingerprint |
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 error To see the latest fingerprint, make a A base64-encoded string. |
licenseCodes[] |
[Output Only] Integer license codes indicating which licenses are attached to this snapshot. |
storageLocations[] |
Cloud Storage bucket storage location of the snapshot (regional or multi-regional). |
autoCreated |
[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. |
downloadBytes |
[Output Only] Number of bytes downloaded to restore a snapshot to a disk. |
chainName |
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. |
satisfiesPzs |
[Output Only] Reserved for future use. |
locationHint |
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. |
kind |
[Output Only] Type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
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.snapshots.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.