REST Resource: regionDisks

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 (Status),
  "sourceSnapshot": string,
  "sourceSnapshotId": string,
  "sourceStorageObject": string,
  "options": string,
  "selfLink": string,
  "sourceImage": string,
  "sourceImageId": string,
  "type": string,
  "licenses": [
    string
  ],
  "guestOsFeatures": [
    {
      object (GuestOsFeature)
    }
  ],
  "lastAttachTimestamp": string,
  "lastDetachTimestamp": string,
  "users": [
    string
  ],
  "diskEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "sourceImageEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "sourceSnapshotEncryptionKey": {
    object (CustomerEncryptionKey)
  },
  "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 (AccessMode),
  "asyncPrimaryDisk": {
    object (AsyncReplication)
  },
  "asyncSecondaryDisks": {
    string: {
      object (AsyncReplicationList)
    },
    ...
  },
  "resourceStatus": {
    object (ResourceStatus)
  },
  "sourceConsistencyGroupPolicy": string,
  "sourceConsistencyGroupPolicyId": string,
  "architecture": enum (Architecture),
  "params": {
    object (DiskParams)
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#disk

for disks.
id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
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.
sizeGb

string (int64 format)

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the

sourceImage

,

sourceSnapshot

, or

sourceDisk

parameter, or specify it alone to create an empty persistent disk.

If you specify this field along with a source, the value of

sizeGb

must not be less than the size of the source. Acceptable values are greater than

0

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

enum (Status)

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

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

string

Internal use only.
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
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.
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.
licenses[]

string

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

object (GuestOsFeature)

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

string

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

string

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

string

[Output Only] Links to the users of the disk (attached instances) in form:

projects/project/zones/zone/instances/instance
diskEncryptionKey

object (CustomerEncryptionKey)

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

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
sourceSnapshotEncryptionKey

object (CustomerEncryptionKey)

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
labels

map (key: string, value: string)

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

setLabels

method.
labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error

412 conditionNotMet

.

To see the latest fingerprint, make a

get()

request to retrieve a disk.

A base64-encoded string.
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[]

string

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

string (int64 format)

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

string (int64 format)

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
resourcePolicies[]

string

Resource policies applied to this disk for automatic snapshot creations.
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:

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

string (int64 format)

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

string (int64 format)

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

boolean

Whether this disk is using confidential compute mode.
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:

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

boolean

[Output Only] Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future 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.
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:

accessMode

enum (AccessMode)

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

object (AsyncReplication)

Disk asynchronously replicated into this disk.
asyncSecondaryDisks

map (key: string, value: object (AsyncReplicationList))

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

object (ResourceStatus)

[Output Only] Status information for the disk resource.
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.
architecture

enum (Architecture)

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

object (DiskParams)

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

Methods

addResourcePolicies

 The method compute.v1.RegionDisksService.AddResourcePolicies is not available in this (s3nsapis.fr) universe.

bulkInsert

 The method compute.v1.RegionDisksService.BulkInsert is not available in this (s3nsapis.fr) universe.

createSnapshot

 The method compute.v1.RegionDisksService.CreateSnapshot is not available in this (s3nsapis.fr) universe.

delete

 The method compute.v1.RegionDisksService.Delete is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.RegionDisksService.Get is not available in this (s3nsapis.fr) universe.

getIamPolicy

 The method compute.v1.RegionDisksService.GetPolicy is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.RegionDisksService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.RegionDisksService.List is not available in this (s3nsapis.fr) universe.

removeResourcePolicies

 The method compute.v1.RegionDisksService.RemoveResourcePolicies is not available in this (s3nsapis.fr) universe.

resize

 The method compute.v1.RegionDisksService.Resize is not available in this (s3nsapis.fr) universe.

setIamPolicy

 The method compute.v1.RegionDisksService.SetPolicy is not available in this (s3nsapis.fr) universe.

setLabels

 The method compute.v1.RegionDisksService.SetLabels is not available in this (s3nsapis.fr) universe.

startAsyncReplication

 The method compute.v1.RegionDisksService.StartAsyncReplication is not available in this (s3nsapis.fr) universe.

stopAsyncReplication

 The method compute.v1.RegionDisksService.StopAsyncReplication is not available in this (s3nsapis.fr) universe.

stopGroupAsyncReplication

 The method compute.v1.RegionDisksService.StopGroupAsyncReplication is not available in this (s3nsapis.fr) universe.

testIamPermissions

 The method compute.v1.RegionDisksService.TestPermissions is not available in this (s3nsapis.fr) universe.

update

 The method compute.v1.RegionDisksService.Update is not available in this (s3nsapis.fr) universe.