- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Retrieves the list of Snapshot resources contained within the specified project.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/snapshots
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
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, "items": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "status": enum, "sourceDisk": string, "sourceDiskId": string, "diskSizeGb": string, "storageBytes": string, "storageBytesStatus": enum, "licenses": [ string ], "snapshotEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string }, "sourceDiskEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string }, "selfLink": string, "labels": { object }, "labelFingerprint": string, "licenseCodes": [ string ], "storageLocations": [ string ], "autoCreated": boolean, "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of Snapshot resources. |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].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 |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].status |
[Output Only] The status of the snapshot. This can be |
items[].sourceDisk |
[Output Only] The source disk used to create this snapshot. |
items[].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. |
items[].diskSizeGb |
[Output Only] Size of the snapshot, specified in GB. |
items[].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. |
items[].storageBytesStatus |
[Output Only] An indicator whether |
items[].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). |
items[].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. |
items[].snapshotEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].snapshotEncryptionKey.rsaEncryptedKey |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items[].snapshotEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].snapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].snapshotEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used |
items[].sourceDiskEncryptionKey |
The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. |
items[].sourceDiskEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].sourceDiskEncryptionKey.rsaEncryptedKey |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items[].sourceDiskEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].sourceDiskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].sourceDiskEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used |
items[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].labels |
Labels to apply to this snapshot. These can be later modified by the An object containing a list of |
items[].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. |
items[].licenseCodes[] |
[Output Only] Integer license codes indicating which licenses are attached to this snapshot. |
items[].storageLocations[] |
Cloud Storage bucket storage location of the snapshot (regional or multi-regional). |
items[].autoCreated |
[Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. |
items[].kind |
[Output Only] Type of the resource. Always |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
kind |
Type of resource. |
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 Google IAM permissions:
compute.snapshots.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.