Compute Cloud API, REST: Filesystem.Create

Written by

Updated at December 17, 2024

HTTP request
Body parameters
Response
CreateFilesystemMetadata
Status
Filesystem

Creates a filesystem in the specified folder.

HTTP request

POST https://compute.api.cloud.yandex.net/compute/v1/filesystems

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "typeId": "string",
  "zoneId": "string",
  "size": "string",
  "blockSize": "string"
}

Field	Description
folderId	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.
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 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	string (int64) Required field. Size of the filesystem, specified in bytes. The size of the filesystem cannot be updated after the filesystem creation.
blockSize	string (int64) Block size used for the filesystem, specified in bytes. The block size cannot be updated after the filesystem creation. Default value: 4096.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "filesystemId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "typeId": "string",
    "zoneId": "string",
    "size": "string",
    "blockSize": "string",
    "status": "string"
  }
  // 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.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean 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	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

filesystemId

string

ID of the filesystem that is being created.

Status

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

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Filesystem

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

Field	Description
id	string ID of the filesystem. Generated at creation time.
folderId	string ID of the folder that the filesystem belongs to.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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.
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	string (int64) Size of the filesystem, specified in bytes.
blockSize	string (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.