Skip to main content

AttachDisk

Attaches the disk to the instance.

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

const AttachInstanceDiskRequest =
  cloudApi.compute.instance_service.AttachInstanceDiskRequest;
const AttachedDiskSpec_Mode =
  cloudApi.compute.instance_service.AttachedDiskSpec_Mode;
const Instance = cloudApi.compute.instance.Instance;

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

  const operation = await client.attachDisk(
    AttachInstanceDiskRequest.fromPartial({
      instanceId: "instanceId",
      attachedDiskSpec: {
        // mode: AttachedDiskSpec_Mode.READ_ONLY,
        // deviceName: "deviceName",
        // autoDelete: true,
        // diskSpec: {
        // name: "name",
        // description: "description",
        // typeId: "typeId",
        // size: 0,
        // imageId: "imageId",
        // snapshotId: "snapshotId",
        // diskPlacementPolicy: {
        // placementGroupId: "placementGroupId",
        // placementGroupPartition: 0
        // },
        // blockSize: 0,
        // kmsKeyId: "kmsKeyId"
        // },
        // diskId: "diskId"
      },
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

AttachInstanceDiskRequest​

instanceId : string​

ID of the instance to attach the disk to. To get the instance ID, use a InstanceService.List request.

attachedDiskSpec : AttachedDiskSpec​

Disk that should be attached.

AttachedDiskSpec​

Mode​
  • MODE_UNSPECIFIED

  • READ_ONLY

    Read-only access.

  • READ_WRITE

    Read/Write access. Default value.

DiskSpec​
name : string​

Name of the disk.

description : string​

Description of the disk.

typeId : string​

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

size : int64​

Size of the disk, specified in bytes.

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.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

blockSize : int64​

Block size of the disk, specified in bytes. The default is 4096.

kmsKeyId : string​

ID of KMS key for disk encryption

mode : Mode​

The mode in which to attach this disk.

deviceName : string​

Specifies a unique serial number of your choice that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance.

This value can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, a random value will be generated.

autoDelete : bool​

Specifies whether the disk will be auto-deleted when the instance is deleted.

One of disk​

  • diskSpec : DiskSpec​

    Disk specification.

  • diskId : string​

    ID of the disk that should be attached.

DiskPlacementPolicy​

placementGroupId : string​

Placement group ID.

placementGroupPartition : int64​

DiskSpec​

name : string​

Name of the disk.

description : string​

Description of the disk.

typeId : string​

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

size : int64​

Size of the disk, specified in bytes.

  • imageId : string​

    ID of the image to create the disk from.

  • snapshotId : string​

    ID of the snapshot to restore the disk from.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

blockSize : int64​

Block size of the disk, specified in bytes. The default is 4096.

kmsKeyId : string​

ID of KMS key for disk encryption

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.