Querying the Instance Quotas of a Tenant
Function
This API is used to query the resource quotas of a specified tenant. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/project-quotas
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
No |
String |
Quota of a specified type. Value: instance |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
|
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
quotas |
project-quotas object |
Tenant instance quota information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
resources |
Array of resource objects |
Resource list objects. |
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
String |
Quota of a specified type. Its value is instance. |
|
used |
Integer |
Number of created resources. |
|
quota |
Integer |
Maximum resource quota. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Querying the instance quotas of a tenant
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance
Example Response
Status code: 200
Success.
{
"quotas" : {
"resources" : [ {
"type" : "instance,",
"used" : "4,",
"quota" : 50
} ]
}
}
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
