Help Center/ Scalable File Service Turbo/ API Reference/ API/ Directory Management/ Creating Quota Limits for a Directory
Updated on 2025-09-17 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating Quota Limits for a Directory

Function

This API is used to create quota limits for a directory.

URI

POST /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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The account token.

Content-Type

Yes

String

The MIME type.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

path

Yes

String

The valid full path of an existing directory.

capacity

No

Integer

The capacity limit of the directory, in MB. If it is not specified, default value 0 will be used, and data cannot be written to the directory. Use capacity or quota, or both.

inode

No

Integer

The quantity limit of the directory's inodes. If it is not specified, default value 0 will be used, and data cannot be written to the directory. Use capacity or quota, or both.

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.

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.

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

Configuring quota limits for the /data/test directory, with the capacity limit set to 1024 MB and quantity limit of inodes set to 100000.

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

Example Responses

Status code: 200

Directory quota limits configured

{
  "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 configured

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Directory Management