Skip to main content

ListSnapshots

Retrieves the list of snapshots created by the specified snapshot schedule.

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

const ListSnapshotScheduleSnapshotsRequest =
  cloudApi.compute.snapshot_schedule_service
    .ListSnapshotScheduleSnapshotsRequest;

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

  const result = await client.listSnapshots(
    ListSnapshotScheduleSnapshotsRequest.fromPartial({
      // snapshotScheduleId: "snapshotScheduleId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

ListSnapshotScheduleSnapshotsRequest​

snapshotScheduleId : string​

ID of the snapshot schedule to list created snapshots for.

To get a snapshot schedule ID, make a SnapshotScheduleService.List request.

pageSize : int64​

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListSnapshotScheduleOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

Default value: 100.

pageToken : string​

Page token. To get the next page of results, set page_token to the ListSnapshotScheduleOperationsResponse.next_page_token returned by a previous list request.

ListSnapshotScheduleSnapshotsResponse​

snapshots : Snapshot​

List of snapshots created by the specified snapshot schedule.

nextPageToken : string​

Token for getting the next page of the list. If the number of results is greater than the specified ListSnapshotScheduleSnapshotsRequest.page_size, use next_page_token as the value for the ListSnapshotScheduleSnapshotsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Snapshot​

A Snapshot resource. For more information, see Snapshots.

Status​
  • STATUS_UNSPECIFIED

  • CREATING

    Snapshot is being created.

  • READY

    Snapshot is ready to use.

  • ERROR

    Snapshot encountered a problem and cannot operate.

  • DELETING

    Snapshot is being deleted.

id : string​

ID of the snapshot.

folderId : string​

ID of the folder that the snapshot belongs to.

createdAt : google.protobuf.Timestamp​
name : string​

Name of the snapshot. 1-63 characters long.

description : string​

Description of the snapshot. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

storageSize : int64​

Size of the snapshot, specified in bytes.

diskSize : int64​

Size of the disk when the snapshot was created, specified in 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 the platform. 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 Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.

status : Status​

Current status of the snapshot.

sourceDiskId : string​

ID of the source disk used to create this snapshot.

hardwareGeneration : HardwareGeneration​

If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used.

kmsKey : KMSKey​

Key encryption key info.

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​

KMSKey​

keyId : string​

ID of KMS symmetric key

versionId : string​

Version of KMS symmetric key

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).