Skip to main content

List

Lists filesystems in the specified folder.

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

const ListFilesystemsRequest =
  cloudApi.compute.filesystem_service.ListFilesystemsRequest;

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

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

ListFilesystemsRequest​

folderId : string​

ID of the folder to list filesystems in.

To get the folder ID, make 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 ListFilesystemsResponse.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 ListFilesystemsResponse.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

ListFilesystemsResponse​

filesystems : Filesystem​

List of filesystems in the specified folder.

nextPageToken : string​

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

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

Filesystem​

A filesystem resource. For details about the concept, see documentation.

Status​
  • STATUS_UNSPECIFIED

  • CREATING

    The filesystem is being created.

  • READY

    The filesystem is ready to use.

  • ERROR

    The filesystem encountered a problem and cannot operate.

  • DELETING

    The filesystem is being deleted.

id : string​

ID of the filesystem. Generated at creation time.

folderId : string​

ID of the folder that the filesystem belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the filesystem. The name is unique within the folder.

description : string​

Description of the filesystem.

labels : string​

Filesystem labels as key:value pairs. For details about the concept, see documentation.

typeId : string​

ID of the filesystem type.

To get a list of available filesystem types, make a yandex.cloud.compute.v1.DiskTypeService.List request.

zoneId : string​

ID of the availability zone where the filesystem resides.

A filesystem can be attached only to instances residing in the same availability zone.

size : int64​

Size of the filesystem, specified in bytes.

blockSize : int64​

Block size used for the filesystem, specified in bytes.

status : Status​

Current status of the filesystem.