Help Center> Scalable File Service> API Reference> SFS Turbo APIs> Directory Management> Querying Quotas of a Directory
Updated on 2024-01-03 GMT+08:00
View PDF

Querying Quotas of a Directory

Function

This API is used to query quotas of a directory.

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

Project ID

share_id

Yes

String

File system ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

path

Yes

String

Valid full path of an existing directory

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token

Content-Type

Yes

String

MIME type

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 size of the directory, in MB. This parameter is returned only for SFS Turbo HPC file systems.

used_inode

Integer

Number of used inodes in the directory. This parameter is returned only for SFS Turbo HPC file systems.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Error code

Minimum: 8

Maximum: 36

errMsg

String

Error description

Minimum: 2

Maximum: 512

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Error code

Minimum: 8

Maximum: 36

errMsg

String

Error description

Minimum: 2

Maximum: 512

Example Requests

Querying the quotas 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 quotas 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 quotas queried

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Directory Management