Querying Quota Usage
Function
This API is used to query the current and used quotas of resources related to a load balancer.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/quotas/details
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
quota_key |
No |
Array of strings |
Definition: Specifies the quota type. Multiple values can be used for query in the format of quota_key=xxx"a_key=xxx. Constraints: N/A Range: loadbalancer, listener, ipgroup, pool, member, healthmonitor, l7policy, certificate, security_policy, listeners_per_loadbalancer, listeners_per_pool, members_per_pool, condition_per_policy, ipgroup_bindings, ipgroup_max_length, ipgroups_per_listener, pools_per_l7policy, l7policies_per_listener, free_instance_members_per_pool, or free_instance_listeners_per_loadbalancer Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
quotas |
Array of QuotaInfo objects |
Definition: Specifies the resource quotas. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
quota_key |
String |
Definition: Specifies the quota type. Range: loadbalancer, listener, ipgroup, pool, member, healthmonitor, l7policy, certificate, security_policy, listeners_per_loadbalancer, listeners_per_pool, members_per_pool, condition_per_policy, ipgroup_bindings, ipgroup_max_length, ipgroups_per_listener, pools_per_l7policy, l7policies_per_listener, free_instance_members_per_pool, or free_instance_listeners_per_loadbalancer |
quota_limit |
Integer |
Definition: Specifies the total quota. Range:
|
used |
Integer |
Definition: Specifies the used quota. Range: greater than or equal to 0 |
unit |
String |
Definition: Specifies the quota unit. Range: count, indicating the number of resources |
Example Requests
Querying the quota of a specific quota type
https://{ELB_Endpoint}/v3/06b9dc6cbf80d5952f18c0181a2f4654/elb/quotas/details?quota_key=members_per_pool"a_key=loadbalancer
Example Responses
Status code: 200
Successful request.
{ "request_id" : "a396ad8e282d69d1afec6d437fe93c2d", "quotas" : [ { "quota_key" : "members_per_pool", "used" : 992, "quota_limit" : 1000, "unit" : "count" }, { "quota_key" : "security_policy", "used" : 11, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "ipgroup_max_length", "used" : 3, "quota_limit" : 300, "unit" : "count" }, { "quota_key" : "listener", "used" : 803, "quota_limit" : 1500, "unit" : "count" }, { "quota_key" : "pool", "used" : 1009, "quota_limit" : 5000, "unit" : "count" }, { "quota_key" : "certificate", "used" : 608, "quota_limit" : -1, "unit" : "count" }, { "quota_key" : "loadbalancer", "used" : 752, "quota_limit" : 100000, "unit" : "count" }, { "quota_key" : "ipgroup", "used" : 11, "quota_limit" : 1000, "unit" : "count" }, { "quota_key" : "ipgroup_bindings", "used" : 2, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "member", "used" : 3022, "quota_limit" : 10000, "unit" : "count" }, { "quota_key" : "listeners_per_loadbalancer", "used" : 0, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "l7policy", "used" : 148, "quota_limit" : 2000, "unit" : "count" }, { "quota_key" : "healthmonitor", "used" : 762, "quota_limit" : -1, "unit" : "count" }, { "quota_key" : "ipgroups_per_listener", "used" : 5, "quota_limit" : 10, "unit" : "count" }, { "quota_key" : "pools_per_l7policy", "used" : 5, "quota_limit" : 100, "unit" : "count" }, { "quota_key" : "l7policies_per_listener", "used" : 5, "quota_limit" : 100, "unit" : "count" }, { "quota_key" : "free_instance_members_per_pool", "used" : 17, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "free_instance_listeners_per_loadbalancer", "used" : 4, "quota_limit" : 10, "unit" : "count" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
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.