Skip to main content

disks

Creates, updates, deletes, gets or lists a disks resource.

Overview​

Namedisks
TypeResource
Idgoogle.compute.disks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
accessModestringThe 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. (READ_ONLY_MANY, READ_WRITE_MANY, READ_WRITE_SINGLE)
architecturestringThe architecture of the disk. Valid values are ARM64 or X86_64. (ARCHITECTURE_UNSPECIFIED, ARM64, X86_64)
asyncPrimaryDiskobjectDisk asynchronously replicated into this disk. (id: DiskAsyncReplication)
asyncSecondaryDisksobjectOutput only. [Output Only] A list of disks this disk is asynchronously replicated to.
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
diskEncryptionKeyobjectEncrypts 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, thediskEncryptionKey.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. (id: CustomerEncryptionKey)
enableConfidentialComputebooleanWhether this disk is using confidential compute mode.
guestOsFeaturesarrayA 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.
kindstringOutput only. [Output Only] Type of the resource. Always compute#disk for disks. (default: compute#disk)
labelFingerprintstring (byte)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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
labelsobjectLabels to apply to this disk. These can be later modified by the setLabels method.
lastAttachTimestampstringOutput only. [Output Only] Last attach timestamp inRFC3339 text format.
lastDetachTimestampstringOutput only. [Output Only] Last detach timestamp inRFC3339 text format.
licenseCodesarrayInteger license codes indicating which licenses are attached to this disk.
licensesarrayA list of publicly visible licenses. Reserved for Google's use.
locationHintstringAn 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.
optionsstringInternal use only.
paramsobjectInput only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: DiskParams)
physicalBlockSizeBytesstring (int64)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.
provisionedIopsstring (int64)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 theExtreme persistent disk documentation.
provisionedThroughputstring (int64)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.
regionstringOutput only. [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.
replicaZonesarrayURLs of the zones where the disk should be replicated to. Only applicable for regional resources.
resourcePoliciesarrayResource policies applied to this disk for automatic snapshot creations.
resourceStatusobjectOutput only. [Output Only] Status information for the disk resource. (id: DiskResourceStatus)
satisfiesPzibooleanOutput only. Reserved for future use.
satisfiesPzsbooleanOutput only. [Output Only] Reserved for future use.
selfLinkstringOutput only. [Output Only] Server-defined fully-qualified URL for this resource.
sizeGbstring (int64)Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value ofsizeGb must not be less than the size of the source. Acceptable values are greater than 0.
sourceConsistencyGroupPolicystringOutput only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
sourceConsistencyGroupPolicyIdstringOutput only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
sourceDiskstringThe 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
sourceDiskIdstringOutput only. [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.
sourceImagestringThe 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, specifyfamily/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
sourceImageEncryptionKeyobjectThecustomer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey)
sourceImageIdstringOutput only. [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.
sourceInstantSnapshotstringThe 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
sourceInstantSnapshotIdstringOutput only. [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.
sourceSnapshotstringThe 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: - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
sourceSnapshotEncryptionKeyobjectThecustomer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey)
sourceSnapshotIdstringOutput only. [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.
sourceStorageObjectstringThe 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.
statusstringOutput only. [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. (CREATING, DELETING, FAILED, READY, RESTORING, UNAVAILABLE)
storagePoolstringThe 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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool
typestringURL 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.
usersarrayOutput only. [Output Only] Links to the users of the disk (attached instances) in form:projects/project/zones/zone/instances/instance
zonestringOutput only. [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.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, zone, diskReturns the specified persistent disk.
listselectproject, zonereturnPartialSuccess, filter, maxResults, pageToken, orderByRetrieves a list of persistent disks contained within
the specified zone.
aggregated_listselectprojectincludeAllScopes, orderBy, maxResults, pageToken, filter, serviceProjectNumber, returnPartialSuccessRetrieves an aggregated list of persistent disks.

To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.
insertinsertproject, zonesourceImage, requestIdCreates a persistent disk in the specified project using the data
in the request. You can create a disk from a source
(sourceImage, sourceSnapshot, orsourceDisk) or create an empty 500 GB data disk by
omitting all properties. You can also create a disk that is larger than
the default size by specifying the sizeGb property.
updateupdateproject, zone, diskpaths, requestId, updateMaskUpdates the specified disk with the data included in the request.
The update is performed only on selected fields included as part
of update-mask.
deletedeleteproject, zone, diskrequestIdDeletes the specified persistent disk. Deleting a disk removes its data
permanently and is irreversible. However, deleting a disk does not
delete any snapshots
previously made from the disk. You must separatelydelete
snapshots.
start_async_replicationexecproject, zone, diskrequestIdStarts asynchronous replication.
Must be invoked on the primary disk.
stop_group_async_replicationexecproject, zonerequestIdStops asynchronous replication for a consistency group of disks.
Can be invoked either in the primary or secondary scope.
set_labelsexecproject, zone, resourcerequestIdSets the labels on a disk. To learn more about labels, read theLabeling
Resources documentation.
resizeexecproject, zone, diskrequestIdResizes the specified persistent disk.
You can only increase the size of the disk.
stop_async_replicationexecproject, zone, diskrequestIdStops asynchronous replication.
Can be invoked either on the primary or on the secondary disk.
bulk_insertexecproject, zonerequestIdBulk create a set of disks.
bulk_set_labelsexecproject, zonerequestId, resourceSets the labels on many disks at once. To learn more about labels, read theLabeling
Resources documentation.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
diskstring
projectstring
resourcestring
zonestring
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
pathsstring
requestIdstring
resourcestring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)
sourceImagestring
updateMaskstring (google-fieldmask)

SELECT examples​

Returns the specified persistent disk.

SELECT
id,
name,
accessMode,
architecture,
asyncPrimaryDisk,
asyncSecondaryDisks,
creationTimestamp,
description,
diskEncryptionKey,
enableConfidentialCompute,
guestOsFeatures,
kind,
labelFingerprint,
labels,
lastAttachTimestamp,
lastDetachTimestamp,
licenseCodes,
licenses,
locationHint,
options,
params,
physicalBlockSizeBytes,
provisionedIops,
provisionedThroughput,
region,
replicaZones,
resourcePolicies,
resourceStatus,
satisfiesPzi,
satisfiesPzs,
selfLink,
sizeGb,
sourceConsistencyGroupPolicy,
sourceConsistencyGroupPolicyId,
sourceDisk,
sourceDiskId,
sourceImage,
sourceImageEncryptionKey,
sourceImageId,
sourceInstantSnapshot,
sourceInstantSnapshotId,
sourceSnapshot,
sourceSnapshotEncryptionKey,
sourceSnapshotId,
sourceStorageObject,
status,
storagePool,
type,
users,
zone
FROM google.compute.disks
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND disk = '{{ disk }}' -- required
;

INSERT examples​

Creates a persistent disk in the specified project using the data
in the request. You can create a disk from a source
(sourceImage, sourceSnapshot, orsourceDisk) or create an empty 500 GB data disk by
omitting all properties. You can also create a disk that is larger than
the default size by specifying the sizeGb property.

INSERT INTO google.compute.disks (
data__guestOsFeatures,
data__type,
data__provisionedThroughput,
data__labels,
data__architecture,
data__storagePool,
data__options,
data__sourceSnapshotEncryptionKey,
data__description,
data__sourceImage,
data__asyncPrimaryDisk,
data__replicaZones,
data__physicalBlockSizeBytes,
data__licenseCodes,
data__labelFingerprint,
data__licenses,
data__params,
data__accessMode,
data__sourceImageEncryptionKey,
data__locationHint,
data__diskEncryptionKey,
data__sourceDisk,
data__sourceSnapshot,
data__name,
data__sourceInstantSnapshot,
data__sizeGb,
data__provisionedIops,
data__enableConfidentialCompute,
data__sourceStorageObject,
data__resourcePolicies,
project,
zone,
sourceImage,
requestId
)
SELECT 
'{{ guestOsFeatures }}',
'{{ type }}',
'{{ provisionedThroughput }}',
'{{ labels }}',
'{{ architecture }}',
'{{ storagePool }}',
'{{ options }}',
'{{ sourceSnapshotEncryptionKey }}',
'{{ description }}',
'{{ sourceImage }}',
'{{ asyncPrimaryDisk }}',
'{{ replicaZones }}',
'{{ physicalBlockSizeBytes }}',
'{{ licenseCodes }}',
'{{ labelFingerprint }}',
'{{ licenses }}',
'{{ params }}',
'{{ accessMode }}',
'{{ sourceImageEncryptionKey }}',
'{{ locationHint }}',
'{{ diskEncryptionKey }}',
'{{ sourceDisk }}',
'{{ sourceSnapshot }}',
'{{ name }}',
'{{ sourceInstantSnapshot }}',
'{{ sizeGb }}',
'{{ provisionedIops }}',
{{ enableConfidentialCompute }},
'{{ sourceStorageObject }}',
'{{ resourcePolicies }}',
'{{ project }}',
'{{ zone }}',
'{{ sourceImage }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

Updates the specified disk with the data included in the request.
The update is performed only on selected fields included as part
of update-mask.

UPDATE google.compute.disks
SET 
data__guestOsFeatures = '{{ guestOsFeatures }}',
data__type = '{{ type }}',
data__provisionedThroughput = '{{ provisionedThroughput }}',
data__labels = '{{ labels }}',
data__architecture = '{{ architecture }}',
data__storagePool = '{{ storagePool }}',
data__options = '{{ options }}',
data__sourceSnapshotEncryptionKey = '{{ sourceSnapshotEncryptionKey }}',
data__description = '{{ description }}',
data__sourceImage = '{{ sourceImage }}',
data__asyncPrimaryDisk = '{{ asyncPrimaryDisk }}',
data__replicaZones = '{{ replicaZones }}',
data__physicalBlockSizeBytes = '{{ physicalBlockSizeBytes }}',
data__licenseCodes = '{{ licenseCodes }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__licenses = '{{ licenses }}',
data__params = '{{ params }}',
data__accessMode = '{{ accessMode }}',
data__sourceImageEncryptionKey = '{{ sourceImageEncryptionKey }}',
data__locationHint = '{{ locationHint }}',
data__diskEncryptionKey = '{{ diskEncryptionKey }}',
data__sourceDisk = '{{ sourceDisk }}',
data__sourceSnapshot = '{{ sourceSnapshot }}',
data__name = '{{ name }}',
data__sourceInstantSnapshot = '{{ sourceInstantSnapshot }}',
data__sizeGb = '{{ sizeGb }}',
data__provisionedIops = '{{ provisionedIops }}',
data__enableConfidentialCompute = {{ enableConfidentialCompute }},
data__sourceStorageObject = '{{ sourceStorageObject }}',
data__resourcePolicies = '{{ resourcePolicies }}'
WHERE 
project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND disk = '{{ disk }}' --required
AND paths = '{{ paths}}'
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified persistent disk. Deleting a disk removes its data
permanently and is irreversible. However, deleting a disk does not
delete any snapshots
previously made from the disk. You must separatelydelete
snapshots.

DELETE FROM google.compute.disks
WHERE project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND disk = '{{ disk }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods​

Starts asynchronous replication.
Must be invoked on the primary disk.

EXEC google.compute.disks.start_async_replication 
@project='{{ project }}' --required, 
@zone='{{ zone }}' --required, 
@disk='{{ disk }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"asyncSecondaryDisk": "{{ asyncSecondaryDisk }}"
}'
;