Skip to main content

Create

Creates a disk in the specified folder.

You can create an empty disk or restore it from a snapshot or an image. Method starts an asynchronous operation that can be cancelled while it is in progress.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const CreateDiskRequest = cloudApi.compute.disk_service.CreateDiskRequest;
const Disk = cloudApi.compute.disk.Disk;
const PCITopology = cloudApi.compute.hardware_generation.PCITopology;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.DiskServiceClient);

  const operation = await client.create(
    CreateDiskRequest.fromPartial({
      folderId: "folderId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // typeId: "typeId",
      zoneId: "zoneId",
      size: 0,
      // imageId: "imageId",
      // snapshotId: "snapshotId",
      // blockSize: 0,
      // diskPlacementPolicy: {
      // placementGroupId: "placementGroupId",
      // placementGroupPartition: 0
      // },
      // snapshotScheduleIds: ["snapshotScheduleIds"],
      // hardwareGeneration: {
      // legacyFeatures: {
      // pciTopology: PCITopology.PCI_TOPOLOGY_V1
      // },
      // generation2Features: {

      // }
      // },
      // kmsKeyId: "kmsKeyId"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Disk>(finishedOp.response);
    console.log(result);
  }
})();

CreateDiskRequest​

folderId : string​

ID of the folder to create a disk in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

name : string​

Name of the disk.

description : string​

Description of the disk.

labels : string​

Resource labels as key:value pairs.

typeId : string​

ID of the disk type. To get a list of available disk types use the yandex.cloud.compute.v1.DiskTypeService.List request.

zoneId : string​

ID of the availability zone where the disk resides. To get a list of available zones use the yandex.cloud.compute.v1.ZoneService.List request.

size : int64​

Size of the disk, specified in bytes. If the disk was created from a image, this value should be more than the yandex.cloud.compute.v1.Image.min_disk_size value.

One of source​

  • imageId : string​

    ID of the image to create the disk from.

  • snapshotId : string​

    ID of the snapshot to restore the disk from.

blockSize : int64​

Block size used for disk, specified in bytes. The default is 4096.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

snapshotScheduleIds : string​

List of IDs of the snapshot schedules to attach the disk to.

hardwareGeneration : HardwareGeneration​

Specify the overrides to hardware_generation of a source disk, image or snapshot, or to the default values if the source does not define it.

kmsKeyId : string​

ID of KMS key for disk encryption.

DiskPlacementPolicy​

placementGroupId : string​

Placement group ID.

placementGroupPartition : int64​

HardwareGeneration​

A set of features, specific to a particular Compute hardware generation. They are not necessary supported by every host OS or distro, thus they are fixed to an image and are applied to all instances created with it as their boot disk image. These features significantly determine how the instance is created, thus cannot be changed after the fact.

One of features​

  • legacyFeatures : LegacyHardwareFeatures​
  • generation2Features : Generation2HardwareFeatures​

LegacyHardwareFeatures​

A first hardware generation, by default compatible with all legacy images. Allows switching to PCI_TOPOLOGY_V2 and back.

pciTopology : PCITopology​

Generation2HardwareFeatures​

A second hardware generation, which by default assumes PCI_TOPOLOGY_V2 and UEFI boot (with UEFI related features).

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.