Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Compute Cloud API, gRPC: FilesystemService.Create

Written by
Updated at December 17, 2024

Creates a filesystem in the specified folder.

gRPC request

rpc Create (CreateFilesystemRequest) returns (operation.Operation)

CreateFilesystemRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "type_id": "string",
  "zone_id": "string",
  "size": "int64",
  "block_size": "int64"
}

Field

Description

folder_id

string

Required field. 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

object (map<string, string>)

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

type_id

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.

zone_id

string

Required field. 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

Required field. Size of the filesystem, specified in bytes.

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

block_size

int64

Block size used for the filesystem, specified in bytes.

The block size cannot be updated after the filesystem creation.

Default value: 4096.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "filesystem_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "type_id": "string",
    "zone_id": "string",
    "size": "int64",
    "block_size": "int64",
    "status": "Status"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

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

CreateFilesystemMetadata

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.

error

google.rpc.Status

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

Includes only one of the fields error, response.

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.

response

Filesystem

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.

Includes only one of the fields error, response.

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.

CreateFilesystemMetadata

Field

Description

filesystem_id

string

ID of the filesystem that is being created.

Filesystem

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

Field

Description

id

string

ID of the filesystem. Generated at creation time.

folder_id

string

ID of the folder that the filesystem belongs to.

created_at

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

object (map<string, string>)

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

type_id

string

ID of the filesystem type.

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

zone_id

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.

block_size

int64

Block size used for the filesystem, specified in bytes.

status

enum Status

Current status of the filesystem.

  • 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.
Previous
List
Next
Update