Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Compute Cloud
  • Yandex Container Solution
  • Access management
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • ListOperations
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • HTTP request
  • Path parameters
  • Response
  1. API reference
  2. REST
  3. Filesystem
  4. Get

Compute Cloud API, REST: Filesystem.Get

Written by
Yandex Cloud
Updated at December 17, 2024
  • 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

Field

Description

filesystemId

string

Required field. ID of the filesystem to return.

To get the filesystem ID, make a FilesystemService.List request.

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

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.