Disk

JSON Representation
Methods

A set of methods for managing Disk resources.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "typeId": "string",
  "zoneId": "string",
  "size": "string",
  "blockSize": "string",
  "productIds": [
    "string"
  ],
  "status": "string",
  "instanceIds": [
    "string"
  ],
  "diskPlacementPolicy": {
    "placementGroupId": "string"
  },

  //  includes only one of the fields `sourceImageId`, `sourceSnapshotId`
  "sourceImageId": "string",
  "sourceSnapshotId": "string",
  // end of the list of possible fields

}

Field	Description
id	string ID of the disk.
folderId	string ID of the folder that the disk belongs to.
createdAt	string (date-time) String in RFC3339 text format.
name	string Name of the disk. 1-63 characters long.
description	string Description of the disk. 0-256 characters long.
labels	object Resource labels as `key:value` pairs. Maximum of 64 per resource.
typeId	string ID of the disk type.
zoneId	string ID of the availability zone where the disk resides.
size	string (int64) Size of the disk, specified in bytes.
blockSize	string (int64) Block size of the disk, specifiedin bytes.
productIds[]	string License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine. The correct license ID is generated by Yandex.Cloud. IDs are inherited by new resources created from this resource. If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Yandex Object Storage, the license IDs will be lost. You can specify them in the create request.
status	string Current status of the disk. CREATING: Disk is being created. READY: Disk is ready to use. ERROR: Disk encountered a problem and cannot operate. DELETING: Disk is being deleted.
instanceIds[]	string Array of instances to which the disk is attached.
diskPlacementPolicy	object
diskPlacementPolicy. placementGroupId	string Placement group ID.
sourceImageId	string includes only one of the fields `sourceImageId`, `sourceSnapshotId` ID of the image that was used for disk creation.
sourceSnapshotId	string includes only one of the fields `sourceImageId`, `sourceSnapshotId` ID of the snapshot that was used for disk creation.

Methods

Method	Description
create	Creates a disk in the specified folder.
delete	Deletes the specified disk.
get	Returns the specified Disk resource.
list	Retrieves the list of Disk resources in the specified folder.
listOperations	Lists operations for the specified disk.
update	Updates the specified disk.