Skip to main content

Create

Creates a filesystem in the specified folder.

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

const CreateFilesystemRequest =
  cloudApi.compute.filesystem_service.CreateFilesystemRequest;
const Filesystem = cloudApi.compute.filesystem.Filesystem;

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

  const operation = await client.create(
    CreateFilesystemRequest.fromPartial({
      folderId: "folderId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // typeId: "typeId",
      zoneId: "zoneId",
      size: 0,
      // blockSize: 0
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Filesystem>(finishedOp.response);
    console.log(result);
  }
})();

CreateFilesystemRequest​

folderId : string​

ID of the folder to create a filesystem in.

To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name : string​

Name of the filesystem. The name must be 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.

The filesystem type cannot be updated after the filesystem creation.

zoneId : string​

ID of the availability zone where the filesystem resides.

To get a list of available zones, make a yandex.cloud.compute.v1.ZoneService.List request.

A filesystem can be attached only to virtual machines residing in the same availability zone. The filesystem availability zone cannot be updated after the filesystem creation.

size : int64​

Size of the filesystem, specified in bytes.

The size of the filesystem cannot be updated after the filesystem creation.

blockSize : int64​

Block size used for the filesystem, specified in bytes.

The block size cannot be updated after the filesystem creation.

Default value: 4096.

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.