List
|
|||||
|
|
Retrieves the list of Snapshot resources contained within the specified project
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 5 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
filter |
STRING |
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 =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) |
maxResults |
INTEGER |
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
orderBy |
STRING |
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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported |
pageToken |
STRING |
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results |
= Parameter name
= Format
project STRING Required Project ID for this request |
filter STRING 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 =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) |
maxResults INTEGER The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
orderBy STRING 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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported |
pageToken STRING Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results |
Output
This building block provides 38 output parameters
Name | Format | Description |
---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items[] |
OBJECT |
Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) |
items[].autoCreated |
BOOLEAN |
[Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk |
items[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
items[].diskSizeGb |
INTEGER |
[Output Only] Size of the snapshot, specified in GB |
items[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].kind |
STRING |
[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources |
items[].labelFingerprint |
BINARY |
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 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot |
items[].labels |
OBJECT |
Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty |
items[].labels.customKey.value |
STRING |
Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty |
items[].licenseCodes[] |
INTEGER |
|
items[].licenses[] |
STRING |
|
items[].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 |
items[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
items[].snapshotEncryptionKey |
OBJECT |
Represents a customer-supplied encryption key |
items[].snapshotEncryptionKey.kmsKeyName |
STRING |
The name of the encryption key that is stored in Google Cloud KMS |
items[].snapshotEncryptionKey.rawKey |
STRING |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
items[].snapshotEncryptionKey.sha256 |
STRING |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
items[].sourceDisk |
STRING |
[Output Only] The source disk used to create this snapshot |
items[].sourceDiskEncryptionKey |
OBJECT |
Represents a customer-supplied encryption key |
items[].sourceDiskEncryptionKey.kmsKeyName |
STRING |
The name of the encryption key that is stored in Google Cloud KMS |
items[].sourceDiskEncryptionKey.rawKey |
STRING |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
items[].sourceDiskEncryptionKey.sha256 |
STRING |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
items[].sourceDiskId |
STRING |
[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[].status |
ENUMERATION |
[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING |
items[].storageBytes |
INTEGER |
[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 |
ENUMERATION |
[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 UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date |
items[].storageLocations[] |
STRING |
|
kind |
STRING |
Type of resource |
nextPageToken |
STRING |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results |
selfLink |
STRING |
[Output Only] Server-defined URL for this resource |
warning |
OBJECT |
[Output Only] Informational warning message |
warning.code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warning.data[] |
OBJECT |
|
warning.data[].key |
STRING |
[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warning.data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warning.message |
STRING |
[Output Only] A human-readable description of the warning code |
= Parameter name
= Format
id STRING [Output Only] Unique identifier for the resource; defined by the server |
items[] OBJECT Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) |
items[].autoCreated BOOLEAN [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk |
items[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
items[].description STRING An optional description of this resource. Provide this property when you create the resource |
items[].diskSizeGb INTEGER [Output Only] Size of the snapshot, specified in GB |
items[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].kind STRING [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources |
items[].labelFingerprint BINARY 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 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot |
items[].labels OBJECT Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty |
items[].labels.customKey.value STRING Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty |
items[].licenseCodes[] INTEGER |
items[].licenses[] STRING |
items[].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 |
items[].selfLink STRING [Output Only] Server-defined URL for the resource |
items[].snapshotEncryptionKey OBJECT Represents a customer-supplied encryption key |
items[].snapshotEncryptionKey.kmsKeyName STRING The name of the encryption key that is stored in Google Cloud KMS |
items[].snapshotEncryptionKey.rawKey STRING Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
items[].snapshotEncryptionKey.sha256 STRING [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
items[].sourceDisk STRING [Output Only] The source disk used to create this snapshot |
items[].sourceDiskEncryptionKey OBJECT Represents a customer-supplied encryption key |
items[].sourceDiskEncryptionKey.kmsKeyName STRING The name of the encryption key that is stored in Google Cloud KMS |
items[].sourceDiskEncryptionKey.rawKey STRING Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource |
items[].sourceDiskEncryptionKey.sha256 STRING [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource |
items[].sourceDiskId STRING [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[].status ENUMERATION [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING |
items[].storageBytes INTEGER [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 ENUMERATION [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 UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date |
items[].storageLocations[] STRING |
kind STRING Type of resource |
nextPageToken STRING [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results |
selfLink STRING [Output Only] Server-defined URL for this resource |
warning OBJECT [Output Only] Informational warning message |
warning.code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warning.data[] OBJECT |
warning.data[].key STRING [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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warning.data[].value STRING [Output Only] A warning data value corresponding to the key |
warning.message STRING [Output Only] A human-readable description of the warning code |