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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
Request 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
|
Parameter |
Type |
Description |
|---|---|---|
|
quotas |
Quotas object |
Quota details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
String |
Quota type. The value can be:
|
|
used |
Integer |
Used quotas. |
|
quota |
Integer |
Total quotas. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
Object |
Error message. |
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
