disks
Creates, updates, deletes, gets or lists a disks
resource.
Overview
Name | disks |
Type | Resource |
Id | google.compute.disks |
Fields
The following fields are returned by SELECT
queries:
- get
- list
- aggregated_list
Successful response
Name | Datatype | Description |
---|---|---|
id | string (uint64) | [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
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. (pattern: a-z?) |
accessMode | string | 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. |
architecture | string | The architecture of the disk. Valid values are ARM64 or X86_64. |
asyncPrimaryDisk | object | Disk asynchronously replicated into this disk. (id: DiskAsyncReplication) |
asyncSecondaryDisks | object | [Output Only] A list of disks this disk is asynchronously replicated to. |
creationTimestamp | string | [Output Only] Creation timestamp in RFC3339 text format. |
description | string | An optional description of this resource. Provide this property when you create the resource. |
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. (id: CustomerEncryptionKey) |
enableConfidentialCompute | boolean | Whether this disk is using confidential compute mode. |
guestOsFeatures | array | 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. |
kind | string | [Output Only] Type of the resource. Always compute#disk for disks. (default: compute#disk) |
labelFingerprint | string (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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. |
labels | object | Labels to apply to this disk. These can be later modified by the setLabels method. |
lastAttachTimestamp | string | [Output Only] Last attach timestamp in RFC3339 text format. |
lastDetachTimestamp | string | [Output Only] Last detach timestamp in RFC3339 text format. |
licenseCodes | array | Integer license codes indicating which licenses are attached to this disk. |
licenses | array | A list of publicly visible licenses. Reserved for Google's use. |
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. |
options | string | Internal use only. |
params | object | Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: DiskParams) |
physicalBlockSizeBytes | string (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. |
provisionedIops | string (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 the Extreme persistent disk documentation. |
provisionedThroughput | string (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. |
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. |
replicaZones | array | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. |
resourcePolicies | array | Resource policies applied to this disk for automatic snapshot creations. |
resourceStatus | object | [Output Only] Status information for the disk resource. (id: DiskResourceStatus) |
satisfiesPzi | boolean | Output only. Reserved for future use. |
satisfiesPzs | boolean | [Output Only] Reserved for future use. |
selfLink | string | [Output Only] Server-defined fully-qualified URL for this resource. |
sizeGb | string (int64) | 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. |
sourceConsistencyGroupPolicy | string | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. |
sourceConsistencyGroupPolicyId | string | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. |
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: - 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 |
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. |
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 |
sourceImageEncryptionKey | object | The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey) |
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. |
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot |
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. |
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: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot |
sourceSnapshotEncryptionKey | object | The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey) |
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. |
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. |
status | string | [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. |
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool |
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. |
users | array | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance |
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. |
Successful response
Name | Datatype | Description |
---|---|---|
id | string | [Output Only] Unique identifier for the resource; defined by the server. |
items | array | A list of Disk resources. |
kind | string | [Output Only] Type of resource. Always compute#diskList for lists of disks. (default: compute#diskList) |
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. |
Successful response
Name | Datatype | Description |
---|---|---|
id | string (uint64) | [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
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. (pattern: a-z?) |
accessMode | string | 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. |
architecture | string | The architecture of the disk. Valid values are ARM64 or X86_64. |
asyncPrimaryDisk | object | Disk asynchronously replicated into this disk. (id: DiskAsyncReplication) |
asyncSecondaryDisks | object | [Output Only] A list of disks this disk is asynchronously replicated to. |
creationTimestamp | string | [Output Only] Creation timestamp in RFC3339 text format. |
description | string | An optional description of this resource. Provide this property when you create the resource. |
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. (id: CustomerEncryptionKey) |
enableConfidentialCompute | boolean | Whether this disk is using confidential compute mode. |
guestOsFeatures | array | 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. |
kind | string | [Output Only] Type of the resource. Always compute#disk for disks. (default: compute#disk) |
labelFingerprint | string (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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. |
labels | object | Labels to apply to this disk. These can be later modified by the setLabels method. |
lastAttachTimestamp | string | [Output Only] Last attach timestamp in RFC3339 text format. |
lastDetachTimestamp | string | [Output Only] Last detach timestamp in RFC3339 text format. |
licenseCodes | array | Integer license codes indicating which licenses are attached to this disk. |
licenses | array | A list of publicly visible licenses. Reserved for Google's use. |
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. |
options | string | Internal use only. |
params | object | Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: DiskParams) |
physicalBlockSizeBytes | string (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. |
provisionedIops | string (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 the Extreme persistent disk documentation. |
provisionedThroughput | string (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. |
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. |
replicaZones | array | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. |
resourcePolicies | array | Resource policies applied to this disk for automatic snapshot creations. |
resourceStatus | object | [Output Only] Status information for the disk resource. (id: DiskResourceStatus) |
satisfiesPzi | boolean | Output only. Reserved for future use. |
satisfiesPzs | boolean | [Output Only] Reserved for future use. |
selfLink | string | [Output Only] Server-defined fully-qualified URL for this resource. |
sizeGb | string (int64) | 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. |
sourceConsistencyGroupPolicy | string | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. |
sourceConsistencyGroupPolicyId | string | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. |
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: - 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 |
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. |
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 |
sourceImageEncryptionKey | object | The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey) |
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. |
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot |
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. |
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: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot |
sourceSnapshotEncryptionKey | object | The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey) |
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. |
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. |
status | string | [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. |
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool |
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. |
users | array | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance |
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. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | project , region , disk | Returns a specified regional persistent disk. | |
list | select | project , region | filter , maxResults , orderBy , pageToken , returnPartialSuccess | Retrieves the list of persistent disks contained within the specified region. |
aggregated_list | select | project | filter , includeAllScopes , maxResults , orderBy , pageToken , returnPartialSuccess , serviceProjectNumber | Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true . |
insert | insert | project , region | requestId , sourceImage | Creates a persistent regional disk in the specified project using the data included in the request. |
update | update | project , region , disk | paths , requestId , updateMask | Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license. |
delete | delete | project , region , disk | requestId | Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. |
set_labels | exec | project , region , resource | requestId | Sets the labels on the target regional disk. |
bulk_set_labels | exec | project , zone | requestId , resource | Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation. |
resize | exec | project , region , disk | requestId | Resizes the specified regional persistent disk. |
start_async_replication | exec | project , region , disk | requestId | Starts asynchronous replication. Must be invoked on the primary disk. |
stop_async_replication | exec | project , region , disk | requestId | Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk. |
stop_group_async_replication | exec | project , region | requestId | Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope. |
bulk_insert | exec | project , region | requestId | Bulk create a set of disks. |
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.
Name | Datatype | Description |
---|---|---|
disk | string | |
project | string | |
region | string | |
resource | string | |
zone | string | |
filter | string | |
includeAllScopes | boolean | |
maxResults | integer (uint32) | |
orderBy | string | |
pageToken | string | |
paths | string | |
requestId | string | |
resource | string | |
returnPartialSuccess | boolean | |
serviceProjectNumber | string (int64) | |
sourceImage | string | |
updateMask | string (google-fieldmask) |
SELECT
examples
- get
- list
- aggregated_list
Returns a specified regional 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 region = '{{ region }}' -- required
AND disk = '{{ disk }}' -- required;
Retrieves the list of persistent disks contained within the specified region.
SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.disks
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';
Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
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 filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';
INSERT
examples
- insert
- Manifest
Creates a persistent regional disk in the specified project using the data included in the request.
INSERT INTO google.compute.disks (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__sizeGb,
data__zone,
data__status,
data__sourceSnapshot,
data__sourceSnapshotId,
data__sourceStorageObject,
data__options,
data__selfLink,
data__sourceImage,
data__sourceImageId,
data__type,
data__licenses,
data__guestOsFeatures,
data__lastAttachTimestamp,
data__lastDetachTimestamp,
data__users,
data__diskEncryptionKey,
data__sourceImageEncryptionKey,
data__sourceSnapshotEncryptionKey,
data__labels,
data__labelFingerprint,
data__region,
data__replicaZones,
data__licenseCodes,
data__physicalBlockSizeBytes,
data__resourcePolicies,
data__sourceDisk,
data__sourceDiskId,
data__provisionedIops,
data__provisionedThroughput,
data__enableConfidentialCompute,
data__sourceInstantSnapshot,
data__sourceInstantSnapshotId,
data__satisfiesPzs,
data__locationHint,
data__storagePool,
data__accessMode,
data__asyncPrimaryDisk,
data__asyncSecondaryDisks,
data__resourceStatus,
data__sourceConsistencyGroupPolicy,
data__sourceConsistencyGroupPolicyId,
data__architecture,
data__params,
project,
region,
requestId,
sourceImage
)
SELECT
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ sizeGb }}',
'{{ zone }}',
'{{ status }}',
'{{ sourceSnapshot }}',
'{{ sourceSnapshotId }}',
'{{ sourceStorageObject }}',
'{{ options }}',
'{{ selfLink }}',
'{{ sourceImage }}',
'{{ sourceImageId }}',
'{{ type }}',
'{{ licenses }}',
'{{ guestOsFeatures }}',
'{{ lastAttachTimestamp }}',
'{{ lastDetachTimestamp }}',
'{{ users }}',
'{{ diskEncryptionKey }}',
'{{ sourceImageEncryptionKey }}',
'{{ sourceSnapshotEncryptionKey }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ region }}',
'{{ replicaZones }}',
'{{ licenseCodes }}',
'{{ physicalBlockSizeBytes }}',
'{{ resourcePolicies }}',
'{{ sourceDisk }}',
'{{ sourceDiskId }}',
'{{ provisionedIops }}',
'{{ provisionedThroughput }}',
{{ enableConfidentialCompute }},
'{{ sourceInstantSnapshot }}',
'{{ sourceInstantSnapshotId }}',
{{ satisfiesPzs }},
'{{ locationHint }}',
'{{ storagePool }}',
'{{ accessMode }}',
'{{ asyncPrimaryDisk }}',
'{{ asyncSecondaryDisks }}',
'{{ resourceStatus }}',
'{{ sourceConsistencyGroupPolicy }}',
'{{ sourceConsistencyGroupPolicyId }}',
'{{ architecture }}',
'{{ params }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}',
'{{ sourceImage }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;
# Description fields are for documentation purposes
- name: disks
props:
- name: project
value: string
description: Required parameter for the disks resource.
- name: region
value: string
description: Required parameter for the disks resource.
- name: kind
value: string
description: >
[Output Only] Type of the resource. Always compute#disk for disks.
default: compute#disk
- name: id
value: string
description: >
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
- name: creationTimestamp
value: string
description: >
[Output Only] Creation timestamp in RFC3339 text format.
- name: name
value: string
description: >
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.
- name: description
value: string
description: >
An optional description of this resource. Provide this property when you create the resource.
- name: sizeGb
value: string
description: >
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.
- name: zone
value: string
description: >
[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.
- name: status
value: string
description: >
[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.
valid_values: ['CREATING', 'DELETING', 'FAILED', 'READY', 'RESTORING', 'UNAVAILABLE']
- name: sourceSnapshot
value: string
description: >
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: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
- name: sourceSnapshotId
value: string
description: >
[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.
- name: sourceStorageObject
value: string
description: >
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.
- name: options
value: string
description: >
Internal use only.
- name: selfLink
value: string
description: >
[Output Only] Server-defined fully-qualified URL for this resource.
- name: sourceImage
value: string
description: >
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
- name: sourceImageId
value: string
description: >
[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.
- name: type
value: string
description: >
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.
- name: licenses
value: array
description: >
A list of publicly visible licenses. Reserved for Google's use.
- name: guestOsFeatures
value: array
description: >
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.
- name: lastAttachTimestamp
value: string
description: >
[Output Only] Last attach timestamp in RFC3339 text format.
- name: lastDetachTimestamp
value: string
description: >
[Output Only] Last detach timestamp in RFC3339 text format.
- name: users
value: array
description: >
[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
- name: diskEncryptionKey
value: object
description: >
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.
- name: sourceImageEncryptionKey
value: object
description: >
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
- name: sourceSnapshotEncryptionKey
value: object
description: >
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
- name: labels
value: object
description: >
Labels to apply to this disk. These can be later modified by the setLabels method.
- name: labelFingerprint
value: string
description: >
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.
- name: region
value: string
description: >
[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.
- name: replicaZones
value: array
description: >
URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
- name: licenseCodes
value: array
description: >
Integer license codes indicating which licenses are attached to this disk.
- name: physicalBlockSizeBytes
value: string
description: >
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.
- name: resourcePolicies
value: array
description: >
Resource policies applied to this disk for automatic snapshot creations.
- name: sourceDisk
value: string
description: >
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: - 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
- name: sourceDiskId
value: string
description: >
[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.
- name: provisionedIops
value: string
description: >
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.
- name: provisionedThroughput
value: string
description: >
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.
- name: enableConfidentialCompute
value: boolean
description: >
Whether this disk is using confidential compute mode.
- name: sourceInstantSnapshot
value: string
description: >
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
- name: sourceInstantSnapshotId
value: string
description: >
[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.
- name: satisfiesPzs
value: boolean
description: >
[Output Only] Reserved for future use.
- name: locationHint
value: string
description: >
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.
- name: storagePool
value: string
description: >
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool
- name: accessMode
value: string
description: >
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.
valid_values: ['READ_ONLY_MANY', 'READ_WRITE_MANY', 'READ_WRITE_SINGLE']
- name: asyncPrimaryDisk
value: object
description: >
Disk asynchronously replicated into this disk.
- name: asyncSecondaryDisks
value: object
description: >
[Output Only] A list of disks this disk is asynchronously replicated to.
- name: resourceStatus
value: object
description: >
[Output Only] Status information for the disk resource.
- name: sourceConsistencyGroupPolicy
value: string
description: >
[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
- name: sourceConsistencyGroupPolicyId
value: string
description: >
[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
- name: architecture
value: string
description: >
The architecture of the disk. Valid values are ARM64 or X86_64.
valid_values: ['ARCHITECTURE_UNSPECIFIED', 'ARM64', 'X86_64']
- name: params
value: object
description: >
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
- name: requestId
value: string
- name: sourceImage
value: string
UPDATE
examples
- update
Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.
UPDATE google.compute.disks
SET
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__sizeGb = '{{ sizeGb }}',
data__zone = '{{ zone }}',
data__status = '{{ status }}',
data__sourceSnapshot = '{{ sourceSnapshot }}',
data__sourceSnapshotId = '{{ sourceSnapshotId }}',
data__sourceStorageObject = '{{ sourceStorageObject }}',
data__options = '{{ options }}',
data__selfLink = '{{ selfLink }}',
data__sourceImage = '{{ sourceImage }}',
data__sourceImageId = '{{ sourceImageId }}',
data__type = '{{ type }}',
data__licenses = '{{ licenses }}',
data__guestOsFeatures = '{{ guestOsFeatures }}',
data__lastAttachTimestamp = '{{ lastAttachTimestamp }}',
data__lastDetachTimestamp = '{{ lastDetachTimestamp }}',
data__users = '{{ users }}',
data__diskEncryptionKey = '{{ diskEncryptionKey }}',
data__sourceImageEncryptionKey = '{{ sourceImageEncryptionKey }}',
data__sourceSnapshotEncryptionKey = '{{ sourceSnapshotEncryptionKey }}',
data__labels = '{{ labels }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__region = '{{ region }}',
data__replicaZones = '{{ replicaZones }}',
data__licenseCodes = '{{ licenseCodes }}',
data__physicalBlockSizeBytes = '{{ physicalBlockSizeBytes }}',
data__resourcePolicies = '{{ resourcePolicies }}',
data__sourceDisk = '{{ sourceDisk }}',
data__sourceDiskId = '{{ sourceDiskId }}',
data__provisionedIops = '{{ provisionedIops }}',
data__provisionedThroughput = '{{ provisionedThroughput }}',
data__enableConfidentialCompute = {{ enableConfidentialCompute }},
data__sourceInstantSnapshot = '{{ sourceInstantSnapshot }}',
data__sourceInstantSnapshotId = '{{ sourceInstantSnapshotId }}',
data__satisfiesPzs = {{ satisfiesPzs }},
data__locationHint = '{{ locationHint }}',
data__storagePool = '{{ storagePool }}',
data__accessMode = '{{ accessMode }}',
data__asyncPrimaryDisk = '{{ asyncPrimaryDisk }}',
data__asyncSecondaryDisks = '{{ asyncSecondaryDisks }}',
data__resourceStatus = '{{ resourceStatus }}',
data__sourceConsistencyGroupPolicy = '{{ sourceConsistencyGroupPolicy }}',
data__sourceConsistencyGroupPolicyId = '{{ sourceConsistencyGroupPolicyId }}',
data__architecture = '{{ architecture }}',
data__params = '{{ params }}'
WHERE
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND disk = '{{ disk }}' --required
AND paths = '{{ paths}}'
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;
DELETE
examples
- delete
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
DELETE FROM google.compute.disks
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND disk = '{{ disk }}' --required
AND requestId = '{{ requestId }}';
Lifecycle Methods
- set_labels
- bulk_set_labels
- resize
- start_async_replication
- stop_async_replication
- stop_group_async_replication
- bulk_insert
Sets the labels on the target regional disk.
EXEC google.compute.disks.set_labels
@project='{{ project }}' --required,
@region='{{ region }}' --required,
@resource='{{ resource }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"labels": "{{ labels }}",
"labelFingerprint": "{{ labelFingerprint }}"
}';
Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation.
EXEC google.compute.disks.bulk_set_labels
@project='{{ project }}' --required,
@zone='{{ zone }}' --required,
@requestId='{{ requestId }}',
@resource='{{ resource }}'
@@json=
'{
"requests": "{{ requests }}"
}';
Resizes the specified regional persistent disk.
EXEC google.compute.disks.resize
@project='{{ project }}' --required,
@region='{{ region }}' --required,
@disk='{{ disk }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"sizeGb": "{{ sizeGb }}"
}';
Starts asynchronous replication. Must be invoked on the primary disk.
EXEC google.compute.disks.start_async_replication
@project='{{ project }}' --required,
@region='{{ region }}' --required,
@disk='{{ disk }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"asyncSecondaryDisk": "{{ asyncSecondaryDisk }}"
}';
Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
EXEC google.compute.disks.stop_async_replication
@project='{{ project }}' --required,
@region='{{ region }}' --required,
@disk='{{ disk }}' --required,
@requestId='{{ requestId }}';
Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
EXEC google.compute.disks.stop_group_async_replication
@project='{{ project }}' --required,
@region='{{ region }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"resourcePolicy": "{{ resourcePolicy }}"
}';
Bulk create a set of disks.
EXEC google.compute.disks.bulk_insert
@project='{{ project }}' --required,
@region='{{ region }}' --required,
@requestId='{{ requestId }}'
@@json=
'{
"sourceConsistencyGroupPolicy": "{{ sourceConsistencyGroupPolicy }}"
}';