Help Center> Data Encryption Workshop> API Reference> APIs> Key Management APIs> Querying APIs> Querying the Quota of a User
View PDF

Querying the Quota of a User

Function

This API is used to query the quota of a user, that is, the allocated total number of CMKs that can be created by a user and the number of CMKs that has been created by the user.

Constraints

The quota does not include Default Master Keys.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

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

Resource quota list.
Table 5 Resources

Parameter

Type

Description

type

String

Quota type. The value can be:

  • CMK

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

used

Integer

Used quotas.

quota

Integer

Total quotas.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 7 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

None

Example Responses

Status code: 200

Request processing succeeded.

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

Status code: 403

Authentication failed.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code

Description

200

Request processing succeeded.

403

Authentication failed.

Error Codes

See Error Codes.

Parent topic: Querying APIs