Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Compute Cloud
  • Getting started
  • Step-by-step instructions
  • Yandex Container Solution
  • Practical guidelines
  • Concepts
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
    • REST
      • Overview
      • DiskPlacementGroup
      • Disk
      • DiskType
      • Filesystem
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • GpuCluster
      • HostGroup
      • HostType
      • Image
      • Instance
      • PlacementGroup
      • SnapshotSchedule
      • Snapshot
      • Zone
      • Operation
      • InstanceGroup
  • Questions and answers
  1. API reference
  2. REST
  3. Filesystem
  4. get

Compute Cloud API, REST: Filesystem.get

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Response

Returns the specified filesystem.

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

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/filesystems/{filesystemId}

Path parameters

Parameter Description
filesystemId

Required. ID of the filesystem to return.

To get the filesystem ID, make a list request.

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

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

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

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 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 string

Current status of the filesystem.

  • 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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Response