Help Center/ Scalable File Service Turbo/ API Reference/ API/ Directory Management/ Querying Quota Limits of a Directory
Updated on 2025-07-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Quota Limits of a Directory

Function

This API is used to query quota limits of a directory. The used_capacity and used_inode values obtained may not be the latest.

URI

GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir-quota

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

share_id

Yes

String

The file system ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

path

Yes

String

The valid full path of an existing directory.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The account token.

Content-Type

Yes

String

The MIME type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

path

String

The valid full path of an existing directory.

capacity

Integer

The directory capacity limit, in MB.

inode

Integer

The quantity limit of inodes of the directory.

used_capacity

Integer

The used capacity of the directory, in MB. This field is returned only for 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems. The returned data may not be the latest.

used_inode

Integer

The number of inodes used in the directory. This field is returned only for 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems. The returned data may not be the latest.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

Querying the quota limits of the directory /data/test in the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4ddw

GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4ddw/fs/dir-quota?path=/data/test

Example Responses

Status code: 200

Directory quota limits queried

{
  "path" : "/data/test",
  "capacity" : 1024,
  "inode" : 100000
}

Status code: 400

Error response

{
  "errCode" : "SFS.TURBO.0102",
  "errMsg" : "Path is not directory"
}

Status code: 500

Error response

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

Status Codes

Status Code

Description

200

Directory quota limits queried

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Directory Management