Method list
Lists filesystems in the specified folder.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/filesystems
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list filesystems in. To get the folder ID, make a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
filter | A filter expression that filters filesystems listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on the Filesystem.name field. 2. An = operator. 3. The value in double quotes (" ). Must be 3-63 characters long and match the regular expression [a-z]([-a-z0-9]{,61}[a-z0-9])? . Example of a filter: name=my-filesystem . |
Response
HTTP Code: 200 - OK
{
"filesystems": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"typeId": "string",
"zoneId": "string",
"size": "string",
"blockSize": "string",
"status": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
filesystems[] | object A filesystem resource. For details about the concept, see documentation. |
filesystems[]. id |
string ID of the filesystem. Generated at creation time. |
filesystems[]. folderId |
string ID of the folder that the filesystem belongs to. |
filesystems[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
filesystems[]. name |
string Name of the filesystem. The name is unique within the folder. |
filesystems[]. description |
string Description of the filesystem. |
filesystems[]. labels |
object Filesystem labels as |
filesystems[]. typeId |
string ID of the filesystem type. To get a list of available filesystem types, make a list request. |
filesystems[]. 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. |
filesystems[]. size |
string (int64) Size of the filesystem, specified in bytes. |
filesystems[]. blockSize |
string (int64) Block size used for the filesystem, specified in bytes. |
filesystems[]. status |
string Current status of the filesystem.
|
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |