List

Retrieves the list of Snapshot resources in the specified folder.

TypeScript

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

const ListSnapshotsRequest =
  cloudApi.compute.snapshot_service.ListSnapshotsRequest;

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

  const result = await client.list(
    ListSnapshotsRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter",
      // orderBy: "orderBy"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.snapshot_service_pb2 import ListSnapshotsRequest
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)
response = service.List(
    ListSnapshotsRequest(
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken",
        # filter = "filter",
        # order_by = "orderBy"
    )
)
print(response)

ListSnapshotsRequest

folderId : string

ID of the folder to list snapshots in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.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 ListSnapshotsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

pageToken : string

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

filter : string

A filter expression that filters resources listed in the response. The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].

Each condition has the form <field> <operator> <value>, where:

1. <field> is the field name. Currently you can use filtering only on the limited number of fields.
2. <operator> is a logical operator, one of =, !=, IN, NOT IN.
3. <value> represents a value. String values should be written in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).

orderBy : string

By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. The default sorting order is ascending

ListSnapshotsResponse

snapshots : Snapshot

List of snapshots.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListSnapshotsRequest.page_size, use the next_page_token as the value for the ListSnapshotsRequest.page_token query parameter in the next list request. Each subsequent list request 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).

---