Help Center/ Database Security Service/ API Reference/ API/ Querying on the Management Side/ Querying Account Quota Information
Updated on 2025-06-19 GMT+08:00
View PDF

Querying Account Quota Information

Function

This API is used to query tenant quota information.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/dbss/audit/quota

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

Request Parameter

Table 2 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Parameter Type

Description

project_id

String

Project ID.

audit_quota

Long

Remaining quota of the audit instance

cpu

Long

Remaining CPU quota.

ram

Long

Remaining memory quota

Status code: 400

Table 4 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 5 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 6 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 7 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 9 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

/v1/{project_id}/dbss/audit/quota

Example Response

Status code: 200

Succeeded

{
  "project_id" : "0250cb8a80c24c0b9f20f557cb159aad",
  "cpu" : 796,
  "ram" : 1622016,
  "audit_quota" : 1
}

Status code: 400

Client errors

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Code

Status Code

Description

200

Success

400

Client error.

403

Authentication failed.

500

Server error.

Error Codes

For details, see Error Codes.