Querying Resource Quotas
Description
This API is used to query the DDS resource quotas of a tenant, including the cluster instance quota, single node instance quota, and replica set instance quota.
URI
Name |
Type |
IN |
Mandatory |
Description |
---|---|---|---|---|
x-auth-token |
string |
header |
Yes |
User token |
project_id |
string |
path |
Yes |
Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. |
Requests
None
Responses
- Parameter description
Table 2 Response body parameters Parameter
Type
Mandatory
Description
quotas
Object
Yes
Quota information.
For more information, see Table 3.
Table 3 ShowResourcesListResponseBody Parameter
Type
Mandatory
Description
resources
Objects
Yes
The resource objects.
For more information, see Table 4.
Table 4 ShowResourcesDetailResponseBody Parameter
Type
Mandatory
Description
type
String
Yes
The quota resource type. Only the instance type is supported.
mode
String
Yes
The instance type.
- If the value is Single, the quota information of a single node instance is displayed.
- If the value is ReplicaSet, the quota information of a replica set instance is displayed.
- If the value is Sharding, the quota information of a cluster instance is displayed.
quota
Integer
Yes
The existing quota.
used
Integer
Yes
The number of the used instances.
- Response example
{ "quotas" : { "resources" : [ { "type" : "instance", "mode" : "Sharding", "quota" : 80, "used" : 6 }, { "type" : "instance", "mode" : "ReplicaSet", "quota" : 80, "used" : 9 }, { "type" : "instance", "mode" : "Single", "quota" : 1000, "used" : 5 } ] } }
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.