Skip to main content

List

Retrieves the list of Disk resources in the specified folder.

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

const ListDisksRequest = cloudApi.compute.disk_service.ListDisksRequest;

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

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

ListDisksRequest​

folderId : string​

ID of the folder to list disks 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 ListDisksResponse.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 ListDisksResponse.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

ListDisksResponse​

disks : Disk​

List of Disk resources.

nextPageToken : string​

This token allows you to get the next page of results for list requests. If the number of results is larger than ListDisksRequest.page_size, use the next_page_token as the value for the ListDisksRequest.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.

Disk​

A Disk resource. For more information, see Disks.

Status​
  • STATUS_UNSPECIFIED

  • CREATING

    Disk is being created.

  • READY

    Disk is ready to use.

  • ERROR

    Disk encountered a problem and cannot operate.

  • DELETING

    Disk is being deleted.

id : string​

ID of the disk.

folderId : string​

ID of the folder that the disk belongs to.

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

Name of the disk. 1-63 characters long.

description : string​

Description of the disk. 0-256 characters long.

labels : string​

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

typeId : string​

ID of the disk type.

zoneId : string​

ID of the availability zone where the disk resides.

size : int64​

Size of the disk, specified in bytes.

blockSize : int64​

Block size of the disk, 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 disk.

One of source​

  • sourceImageId : string​

    ID of the image that was used for disk creation.

  • sourceSnapshotId : string​

    ID of the snapshot that was used for disk creation.

instanceIds : string​

Array of instances to which the disk is attached.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

hardwareGeneration : HardwareGeneration​

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

kmsKey : KMSKey​

Key encryption key info.

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​

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