Get

Returns the specified filesystem.

To get the list of available filesystems, make a List request.

TypeScript

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

const GetFilesystemRequest =
  cloudApi.compute.filesystem_service.GetFilesystemRequest;

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

  const result = await client.get(
    GetFilesystemRequest.fromPartial({
      filesystemId: "filesystemId",
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.filesystem_service_pb2_grpc import FilesystemServiceStub
from yandex.cloud.compute.v1.filesystem_service_pb2 import GetFilesystemRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(FilesystemServiceStub)
response = service.Get(GetFilesystemRequest(filesystem_id="filesystemId"))
print(response)

GetFilesystemRequest

filesystemId : string

ID of the filesystem to return.

To get the filesystem ID, make a FilesystemService.List request.

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.

---