AttachFilesystem

Attaches the filesystem to the instance.

The instance and the filesystem must reside in the same availability zone.

To use the instance with an attached filesystem, the latter must be mounted. For details, see documentation.

TypeScript

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

const AttachInstanceFilesystemRequest =
  cloudApi.compute.instance_service.AttachInstanceFilesystemRequest;
const AttachedFilesystemSpec_Mode =
  cloudApi.compute.instance_service.AttachedFilesystemSpec_Mode;
const Instance = cloudApi.compute.instance.Instance;

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

  const operation = await client.attachFilesystem(
    AttachInstanceFilesystemRequest.fromPartial({
      instanceId: "instanceId",
      attachedFilesystemSpec: {
        // mode: AttachedFilesystemSpec_Mode.READ_ONLY,
        // deviceName: "deviceName",
        // filesystemId: "filesystemId"
      },
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.instance_service_pb2 import AttachInstanceFilesystemMetadata
from yandex.cloud.compute.v1.instance_service_pb2 import AttachInstanceFilesystemRequest
from yandex.cloud.compute.v1.instance_service_pb2 import AttachedFilesystemSpec
from yandex.cloud.compute.v1.instance_pb2 import Instance
from yandex.cloud.compute.v1.instance_service_pb2_grpc import InstanceServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(InstanceServiceStub)
operation = service.AttachFilesystem(
    AttachInstanceFilesystemRequest(
        instance_id="instanceId",
        attached_filesystem_spec=AttachedFilesystemSpec(
            # mode = AttachedFilesystemSpec.Mode.READ_ONLY,
            # device_name = "deviceName",
            # filesystem_id = "filesystemId"
        ),
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Instance,
    meta_type=AttachInstanceFilesystemMetadata,
)
print(operation_result)

AttachInstanceFilesystemRequest

instanceId : string

ID of the instance to attach the filesystem to.

To get the instance ID, make a InstanceService.List request.

attachedFilesystemSpec : AttachedFilesystemSpec

Filesystem to attach to the instance.

AttachedFilesystemSpec

Mode

• MODE_UNSPECIFIED

• READ_ONLY

  Read-only access.

• READ_WRITE

  Read/Write access. Default value.

mode : Mode

Mode of access to the filesystem that should be attached.

deviceName : string

Name of the device representing the filesystem on the instance.

The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.

If not specified, a random value will be generated.

filesystemId : string

ID of the filesystem that should be attached.

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.

---