Updated on 2026-09-21 GMT+08:00

Querying Quotas

Function

This API is used to query quotas, including the total number of CMKs that can be created by a user and the current quota usage.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/kms/user-quotas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

quotas

Quotas object

Quota details.

Table 4 Quotas

Parameter

Type

Description

resources

Array of Resources objects

Definition

Resource quota list

Range

N/A

Table 5 Resources

Parameter

Type

Description

type

String

Definition

Quota type

Range

  • CMK: CMK quota

  • grant_per_CMK: Maximum number of grants that can be created for a CMK

used

Integer

Definition

Used quota

Range

N/A

quota

Integer

Definition

Total quota

Range

N/A

Example Requests

Query the quota usage of the project whose ID is 0dea2644dc80d5d22ff1c01e3ebea6fc.

/v1.0/0dea2644dc80d5d22ff1c01e3ebea6fc/kms/user-quotas

Example Responses

Status code: 200

Request succeeded.

{
  "quotas" : {
    "resources" : [ {
      "quota" : 20,
      "used" : 20,
      "type" : "CMK"
    }, {
      "quota" : 100,
      "used" : 0,
      "type" : "grant_per_CMK"
    } ]
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.