Resource: Disk
Represents a Persistent Disk resource.
Google Compute Engine has two Disk resources:
Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options.
The disks
resource represents a zonal persistent disk. For more information, read Zonal persistent disks.
The regionDisks
resource represents a regional persistent disk. For more information, read Regional resources.
JSON representation |
---|
{ "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, "type": string, "licenses": [ string ], "guestOsFeatures": [ { "type": enum } ], "lastAttachTimestamp": string, "lastDetachTimestamp": string, "users": [ string ], "diskEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceImageEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceSnapshotEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "labels": { string: string, ... }, "labelFingerprint": string, "region": string, "replicaZones": [ string ], "licenseCodes": [ string ], "physicalBlockSizeBytes": string, "resourcePolicies": [ string ], "sourceDisk": string, "sourceDiskId": string, "provisionedIops": string, "provisionedThroughput": string, "enableConfidentialCompute": boolean, "sourceInstantSnapshot": string, "sourceInstantSnapshotId": string, "satisfiesPzs": boolean, "satisfiesPzi": boolean, "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, "params": { "resourceManagerTags": { string: string, ... } } } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
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. |
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 |
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. |
status |
[Output Only] The status of disk creation.
|
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:
|
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. |
sourceStorageObject |
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 |
options |
Internal use only. |
selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
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
|
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. |
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: |
licenses[] |
A list of publicly visible licenses. Reserved for Google's use. |
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. |
guestOsFeatures[].type |
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
|
lastAttachTimestamp |
[Output Only] Last attach timestamp in RFC3339 text format. |
lastDetachTimestamp |
[Output Only] Last detach timestamp in RFC3339 text format. |
users[] |
[Output Only] Links to the users of the disk (attached instances) in form: |
diskEncryptionKey |
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": "projects/kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version |
diskEncryptionKey.rawKey |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
diskEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
diskEncryptionKey.kmsKeyName |
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 "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
diskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
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. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
sourceImageEncryptionKey |
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
sourceImageEncryptionKey.rawKey |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
sourceImageEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
sourceImageEncryptionKey.kmsKeyName |
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 "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
sourceImageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
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. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
sourceSnapshotEncryptionKey |
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. |
sourceSnapshotEncryptionKey.rawKey |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
sourceSnapshotEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
sourceSnapshotEncryptionKey.kmsKeyName |
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 "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
sourceSnapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
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. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
labels |
Labels to apply to this disk. These can be later modified by the |
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. |
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. |
replicaZones[] |
URLs of the zones where the disk should be replicated to. Only applicable for regional resources. |
licenseCodes[] |
Integer license codes indicating which licenses are attached to this disk. |
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. |
resourcePolicies[] |
Resource policies applied to this disk for automatic snapshot creations. |
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:
|
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. |
provisionedIops |
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. |
provisionedThroughput |
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. |
enableConfidentialCompute |
Whether this disk is using confidential compute mode. |
sourceInstantSnapshot |
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:
|
sourceInstantSnapshotId |
[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. |
satisfiesPzs |
[Output Only] Reserved for future use. |
satisfiesPzi |
Output only. Reserved for future use. |
locationHint |
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. |
storagePool |
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:
|
accessMode |
The access mode of the disk.
|
asyncPrimaryDisk |
Disk asynchronously replicated into this disk. |
asyncPrimaryDisk.disk |
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:
|
asyncPrimaryDisk.diskId |
[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. |
asyncPrimaryDisk.consistencyGroupPolicy |
[Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group. |
asyncPrimaryDisk.consistencyGroupPolicyId |
[Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group. |
asyncSecondaryDisks |
[Output Only] A list of disks this disk is asynchronously replicated to. |
asyncSecondaryDisks.asyncReplicationDisk |
|
asyncSecondaryDisks.asyncReplicationDisk.disk |
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:
|
asyncSecondaryDisks.asyncReplicationDisk.diskId |
[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. |
asyncSecondaryDisks.asyncReplicationDisk.consistencyGroupPolicy |
[Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group. |
asyncSecondaryDisks.asyncReplicationDisk.consistencyGroupPolicyId |
[Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group. |
resourceStatus |
[Output Only] Status information for the disk resource. |
resourceStatus.asyncPrimaryDisk |
|
resourceStatus.asyncPrimaryDisk.state |
|
resourceStatus.asyncSecondaryDisks[] |
Key: disk, value: AsyncReplicationStatus message |
resourceStatus.asyncSecondaryDisks[].state |
|
sourceConsistencyGroupPolicy |
[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. |
sourceConsistencyGroupPolicyId |
[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. |
architecture |
The architecture of the disk. Valid values are ARM64 or X86_64. |
params |
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. |
params.resourceManagerTags |
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 |
Methods |
|
---|---|
|
Adds existing resource policies to a disk. |
|
Retrieves an aggregated list of persistent disks. |
|
Bulk create a set of disks. |
|
Creates a snapshot of a specified persistent disk. |
|
Deletes the specified persistent disk. |
|
Returns the specified persistent disk. |
|
Gets the access control policy for a resource. |
|
Creates a persistent disk in the specified project using the data in the request. |
|
Retrieves a list of persistent disks contained within the specified zone. |
|
Removes resource policies from a disk. |
|
Resizes the specified persistent disk. |
|
Sets the access control policy on the specified resource. |
|
Sets the labels on a disk. |
|
Starts asynchronous replication. |
|
Stops asynchronous replication. |
|
Stops asynchronous replication for a consistency group of disks. |
|
Returns permissions that a caller has on the specified resource. |
|
Updates the specified disk with the data included in the request. |