Console
    Contact Us Start free

    Method: regionDisks.list

    Retrieves the list of persistent disks contained within the specified region.

    HTTP request

    GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/disks

    The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

    Path parameters

    Parameters
    project

    string

    Project ID for this request.
    region

    string

    Name of the region for this request.

    Query parameters

    Parameters
    maxResults

    integer ( uint32 format)

    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 )
    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.
    filter

    string

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request.

    If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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 .

    The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

     labels.owner:*

    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)

    If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

    fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

    The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

    For example, to filter for instances that do not end with name "instance", you would use name ne .*instance .

    You cannot combine constraints on multiple fields using regular expressions.
    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.
    returnPartialSuccess

    boolean

    Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

    For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

    Request body

    The request body must be empty.

    Response body

    A list of Disk resources.

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "items" 
 : 
 [ 
 { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "sizeGb" 
 : 
 string 
 , 
 "zone" 
 : 
 string 
 , 
 "status" 
 : 
 enum 
 , 
 "sourceSnapshot" 
 : 
 string 
 , 
 "sourceSnapshotId" 
 : 
 string 
 , 
 "sourceStorageObject" 
 : 
 string 
 , 
 "options" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "sourceImage" 
 : 
 string 
 , 
 "sourceImageId" 
 : 
 string 
 , 
 "storageType" 
 : 
 enum 
 , 
 "type" 
 : 
 string 
 , 
 "licenses" 
 : 
 [ 
 string 
 ] 
 , 
 "guestOsFeatures" 
 : 
 [ 
 { 
 "type" 
 : 
 enum 
 } 
 ] 
 , 
 "lastAttachTimestamp" 
 : 
 string 
 , 
 "lastDetachTimestamp" 
 : 
 string 
 , 
 "users" 
 : 
 [ 
 string 
 ] 
 , 
 "diskEncryptionKey" 
 : 
 { 
 "sha256" 
 : 
 string 
 , 
 "kmsKeyServiceAccount" 
 : 
 string 
 , 
 "rawKey" 
 : 
 string 
 , 
 "rsaEncryptedKey" 
 : 
 string 
 , 
 "kmsKeyName" 
 : 
 string 
 } 
 , 
 "sourceImageEncryptionKey" 
 : 
 { 
 "sha256" 
 : 
 string 
 , 
 "kmsKeyServiceAccount" 
 : 
 string 
 , 
 "rawKey" 
 : 
 string 
 , 
 "rsaEncryptedKey" 
 : 
 string 
 , 
 "kmsKeyName" 
 : 
 string 
 } 
 , 
 "sourceSnapshotEncryptionKey" 
 : 
 { 
 "sha256" 
 : 
 string 
 , 
 "kmsKeyServiceAccount" 
 : 
 string 
 , 
 "rawKey" 
 : 
 string 
 , 
 "rsaEncryptedKey" 
 : 
 string 
 , 
 "kmsKeyName" 
 : 
 string 
 } 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "labelFingerprint" 
 : 
 string 
 , 
 "region" 
 : 
 string 
 , 
 "replicaZones" 
 : 
 [ 
 string 
 ] 
 , 
 "licenseCodes" 
 : 
 [ 
 string 
 ] 
 , 
 "physicalBlockSizeBytes" 
 : 
 string 
 , 
 "resourcePolicies" 
 : 
 [ 
 string 
 ] 
 , 
 "multiWriter" 
 : 
 boolean 
 , 
 "sourceDisk" 
 : 
 string 
 , 
 "sourceDiskId" 
 : 
 string 
 , 
 "eraseWindowsVssSignature" 
 : 
 boolean 
 , 
 "provisionedIops" 
 : 
 string 
 , 
 "provisionedThroughput" 
 : 
 string 
 , 
 "enableConfidentialCompute" 
 : 
 boolean 
 , 
 "interface" 
 : 
 enum 
 , 
 "sourceInstantSnapshot" 
 : 
 string 
 , 
 "sourceInstantSnapshotId" 
 : 
 string 
 , 
 "satisfiesPzs" 
 : 
 boolean 
 , 
 "satisfiesPzi" 
 : 
 boolean 
 , 
 "userLicenses" 
 : 
 [ 
 string 
 ] 
 , 
 "locationHint" 
 : 
 string 
 , 
 "storagePool" 
 : 
 string 
 , 
 "accessMode" 
 : 
 enum 
 , 
 "asyncPrimaryDisk" 
 : 
 { 
 "disk" 
 : 
 string 
 , 
 "diskId" 
 : 
 string 
 , 
 "consistencyGroupPolicy" 
 : 
 string 
 , 
 "consistencyGroupPolicyId" 
 : 
 string 
 } 
 , 
 "asyncSecondaryDisks" 
 : 
 { 
 string 
 : 
 { 
 "asyncReplicationDisk" 
 : 
 { 
 "disk" 
 : 
 string 
 , 
 "diskId" 
 : 
 string 
 , 
 "consistencyGroupPolicy" 
 : 
 string 
 , 
 "consistencyGroupPolicyId" 
 : 
 string 
 } 
 } 
 , 
 ... 
 } 
 , 
 "resourceStatus" 
 : 
 { 
 "asyncPrimaryDisk" 
 : 
 { 
 "state" 
 : 
 enum 
 } 
 , 
 "asyncSecondaryDisks" 
 : 
 { 
 string 
 : 
 { 
 "state" 
 : 
 enum 
 } 
 , 
 ... 
 } 
 } 
 , 
 "sourceConsistencyGroupPolicy" 
 : 
 string 
 , 
 "sourceConsistencyGroupPolicyId" 
 : 
 string 
 , 
 "architecture" 
 : 
 enum 
 , 
 "locked" 
 : 
 boolean 
 , 
 "params" 
 : 
 { 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "warning" 
 : 
 { 
 "code" 
 : 
 enum 
 , 
 "message" 
 : 
 string 
 , 
 "data" 
 : 
 [ 
 { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 } 
 ] 
 } 
 }
    Fields
    kind

    string

    [Output Only] Type of resource. Always compute#diskList for lists of disks.

    id

    string

    [Output Only] Unique identifier for the resource; defined by the server.

    items[]

    object

    A list of Disk resources.

    items[].kind

    string

    [Output Only] Type of the resource. Always compute#disk for disks.

    items[].id

    string ( uint64 format)

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

    items[].creationTimestamp

    string

    [Output Only] Creation timestamp in RFC3339 text format.

    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 [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.

    items[].description

    string

    An optional description of this resource. Provide this property when you create the resource.

    items[].sizeGb

    string ( int64 format)

    Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage , sourceSnapshot , or sourceDisk parameter, or specify it alone to create an empty persistent disk.

    If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0 .

    items[].zone

    string

    [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

    enum

    [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

    string

    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

    string

    [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[].sourceStorageObject

    string

    The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/ . This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

    items[].options

    string

    Internal use only.

    items[].selfLink

    string

    [Output Only] Server-defined fully-qualified URL for this resource.

    items[].sourceImage

    string

    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 family/debian-9 to use the latest Debian 9 image:

    projects/debian-cloud/global/images/family/debian-9

    Alternatively, use a specific version of a public operating system image:

    projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

    To create a disk with a custom image that you created, specify the image name in the following format:

    global/images/my-custom-image

    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 family/family-name :

    global/images/family/my-image-family

    items[].sourceImageId

    string

    [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[].storageType

    enum

    [Deprecated] Storage type of the persistent disk.

    items[].type

    string

    URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/ project /zones/ zone /diskTypes/ pd-ssd . See Persistent disk types .

    items[].licenses[]

    string

    A list of publicly visible licenses. Reserved for Google's use.

    items[].guestOsFeatures[]

    object

    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

    enum

    The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:

    • VIRTIO_SCSI_MULTIQUEUE
    • WINDOWS
    • MULTI_IP_SUBNET
    • UEFI_COMPATIBLE
    • GVNIC
    • SEV_CAPABLE
    • SUSPEND_RESUME_COMPATIBLE
    • SEV_LIVE_MIGRATABLE_V2
    • SEV_SNP_CAPABLE
    • TDX_CAPABLE
    • IDPF
    • SNP_SVSM_CAPABLE
    For more information, see Enabling guest operating system features .
    items[].lastAttachTimestamp

    string

    [Output Only] Last attach timestamp in RFC3339 text format.

    items[].lastDetachTimestamp

    string

    [Output Only] Last detach timestamp in RFC3339 text format.

    items[].users[]

    string

    [Output Only] Links to the users of the disk (attached instances) in form: projects/ project /zones/ zone /instances/ instance

    items[].diskEncryptionKey

    object

    Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key .

    Encryption keys do not protect access to metadata of the disk.

    After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine.

    After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format:

    "diskEncryptionKey.kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key 
/cryptoKeysVersions/ version
    If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.
    items[].diskEncryptionKey.rawKey

    string

    Specifies a 256-bit customer-supplied encryption key , encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
    items[].diskEncryptionKey.rsaEncryptedKey

    string

    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
     The key must meet the following requirements before you can provide it to Compute Engine:
    1. The key is wrapped using a RSA public key certificate provided by Google.
    2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
    Gets the RSA public key certificate provided by Google at: 
     https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    items[].diskEncryptionKey.kmsKeyName

    string

    The name of the encryption key that is stored in Google Cloud KMS. For example:

    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key
    The fully-qualifed key name may be returned for resource GET requests. For example: 
    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key 
/cryptoKeyVersions/1
    items[].diskEncryptionKey.sha256

    string

    [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    items[].diskEncryptionKey.kmsKeyServiceAccount

    string

    The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:

    "kmsKeyServiceAccount": " name 
@ projectId 
.iam.gserviceaccount.com/
    items[].sourceImageEncryptionKey

    object

    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

    string

    Specifies a 256-bit customer-supplied encryption key , encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
    items[].sourceImageEncryptionKey.rsaEncryptedKey

    string

    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
     The key must meet the following requirements before you can provide it to Compute Engine:
    1. The key is wrapped using a RSA public key certificate provided by Google.
    2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
    Gets the RSA public key certificate provided by Google at: 
     https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    items[].sourceImageEncryptionKey.kmsKeyName

    string

    The name of the encryption key that is stored in Google Cloud KMS. For example:

    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key
    The fully-qualifed key name may be returned for resource GET requests. For example: 
    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key 
/cryptoKeyVersions/1
    items[].sourceImageEncryptionKey.sha256

    string

    [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    items[].sourceImageEncryptionKey.kmsKeyServiceAccount

    string

    The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:

    "kmsKeyServiceAccount": " name 
@ projectId 
.iam.gserviceaccount.com/
    items[].sourceSnapshotEncryptionKey

    object

    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

    string

    Specifies a 256-bit customer-supplied encryption key , encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
    items[].sourceSnapshotEncryptionKey.rsaEncryptedKey

    string

    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
     The key must meet the following requirements before you can provide it to Compute Engine:
    1. The key is wrapped using a RSA public key certificate provided by Google.
    2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
    Gets the RSA public key certificate provided by Google at: 
     https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    items[].sourceSnapshotEncryptionKey.kmsKeyName

    string

    The name of the encryption key that is stored in Google Cloud KMS. For example:

    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key
    The fully-qualifed key name may be returned for resource GET requests. For example: 
    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key 
/cryptoKeyVersions/1
    items[].sourceSnapshotEncryptionKey.sha256

    string

    [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    items[].sourceSnapshotEncryptionKey.kmsKeyServiceAccount

    string

    The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:

    "kmsKeyServiceAccount": " name 
@ projectId 
.iam.gserviceaccount.com/
    items[].labels

    map (key: string, value: string)

    Labels to apply to this disk. These can be later modified by the setLabels method.

    items[].labelFingerprint

    string ( bytes format)

    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 412 conditionNotMet .

    To see the latest fingerprint, make a get() request to retrieve a disk.

    A base64-encoded string.

    items[].region

    string

    [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[]

    string

    URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

    items[].licenseCodes[]

    string ( int64 format)

    Integer license codes indicating which licenses are attached to this disk.

    items[].physicalBlockSizeBytes

    string ( int64 format)

    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[]

    string

    Resource policies applied to this disk for automatic snapshot creations.

    items[].multiWriter

    boolean

    Indicates whether or not the disk can be read/write attached to more than one instance.

    items[].sourceDisk

    string

    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

    string

    [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[].eraseWindowsVssSignature

    boolean

    Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.

    items[].provisionedIops

    string ( int64 format)

    Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation .

    items[].provisionedThroughput

    string ( int64 format)

    Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.

    items[].enableConfidentialCompute

    boolean

    Whether this disk is using confidential compute mode.

    items[].interface
    (deprecated)

    enum

    [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME . The default is SCSI .

    items[].sourceInstantSnapshot

    string

    The source instant 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[].sourceInstantSnapshotId

    string

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

    items[].satisfiesPzs

    boolean

    [Output Only] Reserved for future use.

    items[].satisfiesPzi

    boolean

    Output only. Reserved for future use.

    items[].userLicenses[]

    string

    A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license:

    https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

    items[].locationHint

    string

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

    items[].storagePool

    string

    The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

    items[].accessMode

    enum

    The access mode of the disk.

    • READ_WRITE_SINGLE : The default AccessMode, means the disk can be attached to single instance in RW mode.
    • READ_WRITE_MANY : The AccessMode means the disk can be attached to multiple instances in RW mode.
    • READ_ONLY_MANY : The AccessMode means the disk can be attached to multiple instances in RO mode.
    The AccessMode is only valid for Hyperdisk disk types.
    items[].asyncPrimaryDisk

    object

    Disk asynchronously replicated into this disk.

    items[].asyncPrimaryDisk.disk

    string

    The other disk asynchronously replicated to or from the current disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

    items[].asyncPrimaryDisk.diskId

    string

    [Output Only] The unique ID of the other disk asynchronously replicated to or from the current disk. This value identifies the exact disk that was used to create this replication. For example, if you started replicating the persistent disk from a disk that was later deleted and recreated under the same name, the disk ID would identify the exact version of the disk that was used.

    items[].asyncPrimaryDisk.consistencyGroupPolicy

    string

    [Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.

    items[].asyncPrimaryDisk.consistencyGroupPolicyId

    string

    [Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.

    items[].asyncSecondaryDisks

    map (key: string, value: object)

    [Output Only] A list of disks this disk is asynchronously replicated to.

    items[].asyncSecondaryDisks.asyncReplicationDisk

    object

    items[].asyncSecondaryDisks.asyncReplicationDisk.disk

    string

    The other disk asynchronously replicated to or from the current disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

    items[].asyncSecondaryDisks.asyncReplicationDisk.diskId

    string

    [Output Only] The unique ID of the other disk asynchronously replicated to or from the current disk. This value identifies the exact disk that was used to create this replication. For example, if you started replicating the persistent disk from a disk that was later deleted and recreated under the same name, the disk ID would identify the exact version of the disk that was used.

    items[].asyncSecondaryDisks.asyncReplicationDisk.consistencyGroupPolicy

    string

    [Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.

    items[].asyncSecondaryDisks.asyncReplicationDisk.consistencyGroupPolicyId

    string

    [Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.

    items[].resourceStatus

    object

    [Output Only] Status information for the disk resource.

    items[].resourceStatus.asyncPrimaryDisk

    object

    items[].resourceStatus.asyncPrimaryDisk.state

    enum

    items[].resourceStatus.asyncSecondaryDisks[]

    map (key: string, value: object)

    Key: disk, value: AsyncReplicationStatus message

    items[].resourceStatus.asyncSecondaryDisks[].state

    enum

    items[].sourceConsistencyGroupPolicy

    string

    [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

    items[].sourceConsistencyGroupPolicyId

    string

    [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

    items[].architecture

    enum

    The architecture of the disk. Valid values are ARM64 or X86_64.

    items[].locked

    boolean

    [Output Only] The field indicates if the disk is created from a locked source image. Attachment of a disk created from a locked source image will cause the following operations to become irreversibly prohibited:

    • R/W or R/O disk attachment to any other instance
    • Disk detachment. And the disk can only be deleted when the instance is deleted
    • Creation of images or snapshots
    • Disk cloning

    Furthermore, the instance with at least one disk with locked flag set to true will be prohibited from performing the operations below:

    • Further attachment of secondary disks.
    • Detachment of any disks
    • Create machine images
    • Create instance template
    • regionDisks.delete the instance with --keep-disk parameter set to true for locked disks
    • Attach a locked disk with --auto-delete parameter set to false
    items[].params

    object

    Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

    items[].params.resourceManagerTags

    map (key: string, value: string)

    Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags . Keys must be in the format tagKeys/{tag_key_id} , and values are in the format tagValues/456 . The field is ignored (both PUT & PATCH) when empty.

    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.

    warning

    object

    [Output Only] Informational warning message.

    warning.code

    enum

    [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.message

    string

    [Output Only] A human-readable description of the warning code.

    warning.data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example:

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    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.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/compute.readonly
    • 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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: