Create

Creates a snapshot of the specified disk.

TypeScript

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

const CreateSnapshotRequest =
  cloudApi.compute.snapshot_service.CreateSnapshotRequest;
const PCITopology = cloudApi.compute.hardware_generation.PCITopology;
const Snapshot = cloudApi.compute.snapshot.Snapshot;

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

  const operation = await client.create(
    CreateSnapshotRequest.fromPartial({
      folderId: "folderId",
      diskId: "diskId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // hardwareGeneration: {
      // legacyFeatures: {
      // pciTopology: PCITopology.PCI_TOPOLOGY_V1
      // },
      // generation2Features: {

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

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.snapshot_service_pb2 import CreateSnapshotMetadata
from yandex.cloud.compute.v1.snapshot_service_pb2 import CreateSnapshotRequest
from yandex.cloud.compute.v1.hardware_generation_pb2 import Generation2HardwareFeatures
from yandex.cloud.compute.v1.hardware_generation_pb2 import HardwareGeneration
from yandex.cloud.compute.v1.hardware_generation_pb2 import LegacyHardwareFeatures
from yandex.cloud.compute.v1.hardware_generation_pb2 import PCITopology
from yandex.cloud.compute.v1.snapshot_pb2 import Snapshot
from yandex.cloud.compute.v1.snapshot_service_pb2_grpc import SnapshotServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SnapshotServiceStub)
operation = service.Create(
    CreateSnapshotRequest(
        folder_id="folderId",
        disk_id="diskId",
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # hardware_generation = HardwareGeneration(
        # legacy_features = LegacyHardwareFeatures(
        # pci_topology = PCITopology.PCI_TOPOLOGY_V1
        # ),
        # generation_2_features = Generation2HardwareFeatures(
        # )
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Snapshot,
    meta_type=CreateSnapshotMetadata,
)
print(operation_result)

CreateSnapshotRequest

folderId : string

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

diskId : string

ID of the disk to create the snapshot from. To get the disk ID use a yandex.cloud.compute.v1.DiskService.List request.

name : string

Name of the snapshot.

description : string

Description of the snapshot.

labels : string

Resource labels as key:value pairs.

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.

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.

---