Querying the Resource Quotas of a Specified Enterprise Project
Function
This API is used to query the resource quotas of a specified enterprise project. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/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 |
|---|---|---|---|
|
offset |
No |
String |
Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. Value: 0 to 10000 |
|
limit |
No |
String |
Number of records to be queried. The default value is 10. The value must be a positive integer. The minimum value is 1 and the maximum value is 100. |
|
enterprise_project_name |
No |
String |
Enterprise project name. |
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 |
|---|---|---|
|
quota_list |
Array of quota objects |
Resource list objects. |
|
total_count |
Integer |
Number of quota records. |
|
Parameter |
Type |
Description |
|---|---|---|
|
enterprise_project_id |
String |
Enterprise project ID. |
|
enterprise_project_name |
String |
Enterprise project name. |
|
instance_quota |
Integer |
Quota of the DB instance quantity. |
|
vcpus_quota |
Integer |
Quota of vCPUs. |
|
ram_quota |
Integer |
Memory quota in GB. |
|
availability_instance_quota |
Integer |
Remaining quota of DB instances. |
|
availability_vcpus_quota |
Integer |
Remaining quota of vCPUs. |
|
availability_ram_quota |
Integer |
Remaining memory 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 resource quotas
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas
Example Response
Status code: 200
Success.
{
"quota_list" : [ {
"enterprise_project_id" : "0",
"enterprise_project_name" : "default",
"instance_quota" : 20,
"vcpus_quota" : 20,
"ram_quota" : 40,
"availability_instance_quota" : 1,
"availability_vcpus_quota" : 4,
"availability_ram_quota" : 8
} ]
}
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.
