Help Center/ Scalable File Service Turbo/ API Reference/ API/ Tenant Quota Management/ Querying Tenant Quotas
Updated on 2025-09-17 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Tenant Quotas

Function

Querying tenant quotas

URI

GET /v1/{project_id}/sfs-turbo/quotas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project 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.

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 4 Response body parameters

Parameter

Type

Description

quotas

Array of QuotaResource objects

Querying tenant quotas
Table 5 QuotaResource

Parameter

Type

Description

type

String

The tenant quota type. shares indicates the file system quantity quota, and capacity indicates the file system capacity quota.

Enumeration values:

  • shares

  • capacity

used

Integer

The used quota.

quota

Integer

The total quota.

unit

String

The quota unit.

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 7 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 9 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

None

Example Responses

Status code: 200

Success

{
  "quotas" : {
    "resources" : [ {
      "type" : "shares",
      "used" : 5,
      "quota" : 400
    }, {
      "type" : "capacity",
      "used" : 0,
      "quota" : 20,
      "unit" : "GB"
    } ]
  }
}

Status code: 400

Error response

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Success

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Tenant Quota Management