- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Retrieves the list of persistent disks contained within the specified region.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region 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:
By default, each expression is an
|
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 |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today. |
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, "sizeGb": string, "zone": string, "status": enum, "sourceSnapshot": string, "sourceSnapshotId": string, "options": string, "selfLink": string, "sourceImage": string, "sourceImageId": string, "type": string, "licenses": [ string ], "guestOsFeatures": [ { "type": enum } ], "lastAttachTimestamp": string, "lastDetachTimestamp": string, "users": [ string ], "diskEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "kmsKeyName": string }, "sourceImageEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "kmsKeyName": string }, "sourceSnapshotEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "kmsKeyName": string }, "labels": { string: string, ... }, "labelFingerprint": string, "region": string, "replicaZones": [ string ], "licenseCodes": [ string ], "physicalBlockSizeBytes": string, "resourcePolicies": [ string ], "sourceDisk": string, "sourceDiskId": string, "satisfiesPzs": 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 Disk 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[].sizeGb |
Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the If you specify this field along with a source, the value of |
items[].zone |
[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
items[].status |
[Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting. |
items[].sourceSnapshot |
The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
|
items[].sourceSnapshotId |
[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. |
items[].options |
Internal use only. |
items[].selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
items[].sourceImage |
The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify
Alternatively, use a specific version of a public operating system image:
To create a disk with a custom image that you created, specify the image name in the following format:
You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with
|
items[].sourceImageId |
[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. |
items[].type |
URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: |
items[].licenses[] |
A list of publicly visible licenses. Reserved for Google's use. |
items[].guestOsFeatures[] |
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
items[].guestOsFeatures[].type |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
items[].lastAttachTimestamp |
[Output Only] Last attach timestamp in RFC3339 text format. |
items[].lastDetachTimestamp |
[Output Only] Last detach timestamp in RFC3339 text format. |
items[].users[] |
[Output Only] Links to the users of the disk (attached instances) in form: |
items[].diskEncryptionKey |
Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. |
items[].diskEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].diskEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].diskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].diskEncryptionKey.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. |
items[].sourceImageEncryptionKey |
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
items[].sourceImageEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].sourceImageEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].sourceImageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].sourceImageEncryptionKey.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. |
items[].sourceSnapshotEncryptionKey |
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. |
items[].sourceSnapshotEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].sourceSnapshotEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].sourceSnapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].sourceSnapshotEncryptionKey.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. |
items[].labels |
Labels to apply to this disk. These can be later modified by the An object containing a list of |
items[].labelFingerprint |
A fingerprint for the labels being applied to this disk, 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[].region |
[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
items[].replicaZones[] |
URLs of the zones where the disk should be replicated to. Only applicable for regional resources. |
items[].licenseCodes[] |
Integer license codes indicating which licenses are attached to this disk. |
items[].physicalBlockSizeBytes |
Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. |
items[].resourcePolicies[] |
Resource policies applied to this disk for automatic snapshot creations. |
items[].sourceDisk |
The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
|
items[].sourceDiskId |
[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. |
items[].satisfiesPzs |
[Output Only] Reserved for future use. |
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 |
[Output Only] Type of 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.disks.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.