disks

Overview

Name	disks
Type	Resource
Id	google.compute.disks

Fields

Name	Datatype	Description
id	string	[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.
description	string	An optional description of this resource. Provide this property when you create the resource.
sourceSnapshotEncryptionKey	object
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
asyncSecondaryDisks	object	[Output Only] A list of disks this disk is asynchronously replicated to.
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.
physicalBlockSizeBytes	string	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.
params	object	Additional disk params.
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
labelFingerprint	string	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.
sizeGb	string	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.
licenses	array	A list of publicly visible licenses. Reserved for Google's use.
users	array	[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
options	string	Internal use only.
resourcePolicies	array	Resource policies applied to this disk for automatic snapshot creations.
lastAttachTimestamp	string	[Output Only] Last attach timestamp in RFC3339 text format.
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.
provisionedIops	string	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	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 between 1 and 7,124.
diskEncryptionKey	object
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.
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.
lastDetachTimestamp	string	[Output Only] Last detach timestamp in RFC3339 text format.
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.
licenseCodes	array	Integer license codes indicating which licenses are attached to this disk.
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.
replicaZones	array	URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
labels	object	Labels to apply to this disk. These can be later modified by the setLabels method.
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
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
asyncPrimaryDisk	object
satisfiesPzs	boolean	[Output Only] Reserved for future use.
sourceImageEncryptionKey	object
architecture	string	The architecture of the disk. Valid values are ARM64 or X86_64.
kind	string	[Output Only] Type of the resource. Always compute#disk for disks.
selfLink	string	[Output Only] Server-defined fully-qualified URL for this resource.
resourceStatus	object
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.
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.
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.
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.

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of persistent disks.
get	SELECT	disk, project, zone	Returns the specified persistent disk.
list	SELECT	project, zone	Retrieves a list of persistent disks contained within the specified zone.
insert	INSERT	project, zone	Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) 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.
delete	DELETE	disk, project, zone	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 separately delete snapshots.
_aggregated_list	EXEC	project	Retrieves an aggregated list of persistent disks.
bulk_insert	EXEC	project, zone	Bulk create a set of disks.
resize	EXEC	disk, project, zone	Resizes the specified persistent disk. You can only increase the size of the disk.
set_labels	EXEC	project, resource, zone	Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.
start_async_replication	EXEC	disk, project, zone	Starts asynchronous replication. Must be invoked on the primary disk.
stop_async_replication	EXEC	disk, project, zone	Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
stop_group_async_replication	EXEC	project, zone	Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
update	EXEC	disk, project, zone	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. Only the following fields can be modified: user_license.