forked from docs/doc-exports
zhoumeng
b865c4b876
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com> Co-authored-by: zhoumeng <zhoumeng35@huawei.com> Co-committed-by: zhoumeng <zhoumeng35@huawei.com>
263 lines
12 KiB
HTML
263 lines
12 KiB
HTML
<a name="ListQuotaDetails"></a><a name="ListQuotaDetails"></a>
|
|
|
|
<h1 class="topictitle1">Querying Quota Usage</h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the current quotas and used quotas of resources related to a dedicated load balancer in a specific project.</p>
|
|
</div>
|
|
<div class="section" id="ListQuotaDetails__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v3/{project_id}/elb/quotas/details</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>quota_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Specifies the resource type. The value can be <strong>loadbalancer</strong>, <strong>listener</strong>, <strong>ipgroup</strong>, <strong>pool</strong>, <strong>member</strong>, <strong>healthmonitor</strong>, <strong>l7policy</strong>, <strong>certificate</strong>,** security_policy**,<strong>members_per_pool</strong>, <strong>ipgroup_bindings</strong>, or <strong>ipgroup_max_length</strong>.</p>
|
|
<p><strong>members_per_pool</strong> indicates the maximum number of backend servers that can be added to a backend server group.</p>
|
|
<p><strong>ipgroup_bindings</strong> indicates the maximum number of listeners that can be bound to a ipgroup.</p>
|
|
<p><strong>ipgroup_max_length</strong> indicates the maximum number of ip addresses that can be added to a ipgroup.</p>
|
|
<p>Multiple values can be queried in the format of <em>quota_key=xxx&quota_key=xxx.</em></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListQuotaDetails__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Specifies the token used for IAM authentication.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListQuotaDetails__response_ListQuotaDetailsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Specifies the request ID. The value is automatically generated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListQuotaDetails__response_QuotaInfo">QuotaInfo</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Specifies the resource quotas.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListQuotaDetails__response_QuotaInfo"></a><a name="response_QuotaInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListQuotaDetails__response_QuotaInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>QuotaInfo</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>quota_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Specifies the resource type. The value can be <strong>loadbalancer</strong>, <strong>listener</strong>, <strong>listeners_per_pool</strong>, <strong>ipgroup</strong>, <strong>pool</strong>, <strong>member</strong>, <strong>members_per_pool</strong>, <strong>healthmonitor</strong>, <strong>l7policy</strong>, <strong>condition_per_policy</strong>, <strong>certificate</strong>, <strong>security_policy</strong>, <strong>ipgroup_bindings</strong>, or <strong>ipgroup_max_length</strong>.</p>
|
|
<p><strong>listeners_per_pool</strong> indicates the maximum number of listeners that can be related to a backend server group.</p>
|
|
<p><strong>members_per_pool</strong> indicates the maximum number of backend servers that can be added to a backend server group.</p>
|
|
<p><strong>ipgroup_bindings</strong> indicates the maximum number of listeners that can be bound to a ipgroup.</p>
|
|
<p><strong>ipgroup_max_length</strong> indicates the maximum number of ip addresses that can be added to a ipgroup.</p>
|
|
<p><strong>condition_per_policy</strong> indicates the maximum number of conditions that can be added to a l7policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>quota_limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Specifies the total quota. Values:</p>
|
|
<ul><li><p>If the value is greater than or equal to 0, it indicates the current quota.</p>
|
|
</li><li><p><strong>-1</strong> indicates that the quota is not limited.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Specifies the used quota.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Specifies the quota unit. The value can only be <strong>count</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying the quota of a specific resource type</p>
|
|
<pre class="screen">https://{ELB_Endpoint}/v3/06b9dc6cbf80d5952f18c0181a2f4654/elb/quotas/details?quota_key=members_per_pool&quota_key=loadbalancer</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
|
<p>Successful request.</p>
|
|
<pre class="screen">{
|
|
"request_id" : "3682f26f8509d52faf895f09040c63c0",
|
|
"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" : "l7policy",
|
|
"used" : 148,
|
|
"quota_limit" : 2000,
|
|
"unit" : "count"
|
|
}, {
|
|
"quota_key" : "healthmonitor",
|
|
"used" : 762,
|
|
"quota_limit" : -1,
|
|
"unit" : "count"
|
|
}, {
|
|
"quota_key" : "listeners_per_pool",
|
|
"used" : 100,
|
|
"quota_limit" : -1,
|
|
"unit" : "count"
|
|
}, {
|
|
"quota_key" : "condition_per_policy",
|
|
"used" : 100,
|
|
"quota_limit" : -1,
|
|
"unit" : "count"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListQuotaDetails__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Successful request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="module_quotas.html">Quota</a></div>
|
|
</div>
|
|
</div>
|
|
|