Help Center/ Scalable File Service Turbo/ API Reference/ API/ Tenant Quota Management/ Querying Tenant Quotas
Updated on 2025-11-14 GMT+08:00
View PDF

Querying Tenant Quotas

Function

Querying tenant quotas

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

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

ShowQuotaResource object

Querying tenant quotas
Table 5 ShowQuotaResource

Parameter

Type

Description

resources

Array of QuotaResource objects

The tenant resource quota.
Table 6 QuotaResource

Parameter

Type

Description

type

String

The tenant's resource type. shares indicates the file system quantity, and capacity indicates the file system capacity.

Enumeration values:

  • shares

  • capacity

used

Integer

The used quota.

quota

Integer

The total quota.

unit

String

The quota unit.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 8 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 10 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