Help Center/ Scalable File Service Turbo/ API Reference/ API/ Directory Management/ Creating Quotas for a Directory
Updated on 2024-11-13 GMT+08:00
View PDF
Share

Creating Quotas for a Directory

Function

This API is used to create quotas for a directory.

Constraints

You can only configure directory quotas on empty directories.

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

Project ID

share_id

Yes

String

File system ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token

Content-Type

Yes

String

MIME type
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

path

Yes

String

Valid full path of an existing directory

capacity

No

Integer

Size of the directory, in MB. If it is set to 0, data cannot be written to the directory. Use either capacity or quota.

inode

No

Integer

Quantity limit of inodes. If it is set to 0, data cannot be written to the directory. Use either capacity or quota.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

path

String

Valid full path of an existing directory

capacity

Integer

Size of the directory, in MB

inode

Integer

Maximum number of inodes allowed in the directory

used_capacity

Integer

Used space 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

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

Error code

errMsg

String

Error description

Status code: 409

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

Error code

errMsg

String

Error description

Example Requests

Creating quotas for the /data/test directory, with the capacity quota set to 1024 MB and number of inodes set to 100000.

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

Example Responses

Status code: 200

Directory quotas created

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

Status code: 400

Error response

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

Status code: 409

Error response

{
  "errCode" : "SFS.TURBO.0112",
  "errMsg" : "quota alreay exist"
}

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Directory quotas created

400

Error response

409

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Directory Management