REST Resource: disks

Resource: Disk

A Disk resource.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "sizeGb": string,
  "zone": string,
  "status": enum,
  "sourceSnapshot": string,
  "sourceSnapshotId": string,
  "options": string,
  "selfLink": string,
  "sourceImage": string,
  "sourceImageId": string,
  "type": string,
  "licenses": [
    string
  ],
  "guestOsFeatures": [
    {
      "type": enum
    }
  ],
  "lastAttachTimestamp": string,
  "lastDetachTimestamp": string,
  "users": [
    string
  ],
  "diskEncryptionKey": {
    "rawKey": string,
    "kmsKeyName": string,
    "sha256": string
  },
  "sourceImageEncryptionKey": {
    "rawKey": string,
    "kmsKeyName": string,
    "sha256": string
  },
  "sourceSnapshotEncryptionKey": {
    "rawKey": string,
    "kmsKeyName": string,
    "sha256": string
  },
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "region": string,
  "replicaZones": [
    string
  ],
  "licenseCodes": [
    string
  ],
  "kind": string
}
Fields
id

string (fixed64 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 of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.

If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.

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

[Output Only] The status of disk creation.

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.

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: project/zones/zone/diskTypes/pd-standard or pd-ssd

licenses[]

string

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

guestOsFeatures[]

object

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

guestOsFeatures[].type

enum

The ID of a supported feature. 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: project/zones/zone/instances/instance

diskEncryptionKey

object

Encrypts the disk using a customer-supplied encryption key.

After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

diskEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

diskEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.

diskEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

sourceImageEncryptionKey

object

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

sourceImageEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

sourceImageEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.

sourceImageEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

sourceSnapshotEncryptionKey

object

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

sourceSnapshotEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

sourceSnapshotEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.

sourceSnapshotEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.

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.

kind

string

[Output Only] Type of the resource. Always compute#disk for disks.

Methods

addResourcePolicies

Adds existing resource policies to a disk.

aggregatedList

Retrieves an aggregated list of persistent disks.

createSnapshot

Creates a snapshot of a specified persistent disk.

delete

Deletes the specified persistent disk.

get

Returns a specified persistent disk.

getIamPolicy

Gets the access control policy for a resource.

insert

Creates a persistent disk in the specified project using the data in the request.

list

Retrieves a list of persistent disks contained within the specified zone.

removeResourcePolicies

Removes resource policies from a disk.

resize

Resizes the specified persistent disk.

setIamPolicy

Sets the access control policy on the specified resource.

setLabels

Sets the labels on a disk.

testIamPermissions

Returns permissions that a caller has on the specified resource.
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine