Querying the Instance Quotas of a Tenant
Function
This API is used to modify 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 /mysql/v3/{project_id}/project-quotas
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. To obtain this value, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
No |
String |
Resource type used to filter quotas. Its value can be instance. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. |
|
X-Language |
No |
String |
Language. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
quotas |
Object |
Tenant instance quota information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
resources |
Array of objects |
Resource list objects. |
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
String |
Quota of the specified type. The value is instance, which indicates the instance quota. |
|
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
GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/quotas?type=instance
Example Response
Status code: 200
Success.
{
"quotas" : {
"resources" : [ {
"type" : "instance",
"used" : 4,
"quota" : 50
} ]
}
}
Status Code
|
Status Code |
Description |
|---|---|
|
200 |
Success. |
|
400 |
Client error. |
|
500 |
Server error. |
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.