doc-exports/elb/api-ref/elb_jd_pe_0001.html

209 lines
18 KiB
HTML

<a name="elb_jd_pe_0001"></a><a name="elb_jd_pe_0001"></a>
<h1 class="topictitle1">Querying Load Balancer or Listener Quotas</h1>
<h4 class="sectiontitle">Function</h4><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p29574398102836">This API is used to query the load balancer or listener quotas.</p>
<h4 class="sectiontitle">URI</h4><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p43605354">GET /v1.0/{project_id}/elbaas/quotas</p>
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_table618348671617" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row536444891617"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.5.1.1"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p502363201617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.2"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p426101401617"><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b842352706192244">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.5.1.3"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p288693491617"><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b842352706145623">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.2.3.2.5.1.4"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p567159381617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row305882841617"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p87851816121312">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p342304371617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p212019881617">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p396394561617">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Request</h4><ul id="elb_jd_pe_0001__en-us_topic_0096561521_ul14640111064018"><li id="elb_jd_pe_0001__en-us_topic_0096561521_li76402010134019">Request parameters<p id="elb_jd_pe_0001__en-us_topic_0096561521_p19671154584917"><a name="elb_jd_pe_0001__en-us_topic_0096561521_li76402010134019"></a><a name="en-us_topic_0096561521_li76402010134019"></a>None</p>
</li></ul>
<ul id="elb_jd_pe_0001__en-us_topic_0096561521_ul11296519134018"><li id="elb_jd_pe_0001__en-us_topic_0096561521_li929611924012">Example request<p id="elb_jd_pe_0001__en-us_topic_0096561521_p15621853114915"><a name="elb_jd_pe_0001__en-us_topic_0096561521_li929611924012"></a><a name="en-us_topic_0096561521_li929611924012"></a>None</p>
</li></ul>
<h4 class="sectiontitle">Response</h4><ul id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_ul14663854154859"><li id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_li64865830154859">Response parameters
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_table951448410185" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row269956210185"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p1733794910185">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p6219660010185"><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b715021011">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p475984410185">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row410792510185"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p6430652610185">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p4144608710185">Object</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p168984810185">Specifies the resource quotas.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_table40566376102127" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b2634191175212">quotas</strong> parameter description</caption><thead align="left"><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row47343998102127"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p9658647102127">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p44152912102127"><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b60403457">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p19616081102127">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row45398723102127"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p53417933102127">resources</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p31885336102127">Array</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p24743468102127">Lists the resource quotas.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_table5936749910208" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b1850491315218">resources</strong> parameter description</caption><thead align="left"><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row3030106010208"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p3846681610208">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p2880442510208"><strong id="elb_jd_pe_0001__en-us_topic_0096561521_b592132753">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p5145709410208">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row727510410208"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p5241254210208">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p1755751310208">String</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p1287242410208">Specifies the resource type. The value can be <strong id="elb_jd_pe_0001__en-us_topic_0096561521_b842352706173642">elb</strong> or <strong id="elb_jd_pe_0001__en-us_topic_0096561521_b842352706173646">listener</strong>.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row4874295510208"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p5586525210208">used</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p2879152510208">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p5041218310208">Specifies the quantity of used resources.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row5105646510208"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p4193303910208">quota</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p4113300910208">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p4343945610208">Specifies the total resource quotas.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row296714099521"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p545739069521">max</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p584102979521">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p336135799521">Specifies the maximum number of resources.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row90942879526"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p655486439526">min</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p78398969526">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p310518629526">Specifies the minimum number of resources.</p>
</td>
</tr>
</tbody>
</table>
</li></ul>
<ul id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_ul23438178"><li id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_li9617010">Example response<pre class="screen" id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_screen1581112710932">{
"quotas": {
"resources": [
{
"type": "elb",
"used": 2,
"quota": 5,
"max": 100,
"min": 1
},
{
"type": "listener",
"quota": 5,
"max": 200,
"min": 1
}
]
}
}</pre>
<img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p64949622104314">The <strong id="elb_jd_pe_0001__en-us_topic_0096561521_b842352706141322">used</strong> parameter is unavailable for listeners, for which an empty character string is returned.</p>
</li></ul>
<h4 class="sectiontitle">Status Code</h4><ul id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_ul19388612"><li id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_li40279785">Normal<p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p26973745"><a name="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_li40279785"></a><a name="en-us_topic_0096561521_en-us_topic_0020100174_li40279785"></a>200</p>
</li><li id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_li41437119">Error
<table cellpadding="4" cellspacing="0" summary="" id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_table45362997151624" frame="border" border="1" rules="all"><thead align="left"><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row56461172151624"><th align="left" class="cellrowborder" valign="top" width="10.299999999999999%" id="mcps1.3.6.2.2.1.1.4.1.1"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p9952202151624">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.46%" id="mcps1.3.6.2.2.1.1.4.1.2"><p id="elb_jd_pe_0001__en-us_topic_0096561521_p18704142212229">Message</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.239999999999995%" id="mcps1.3.6.2.2.1.1.4.1.3"><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p822070151624">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row66587677151624"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p24892777151624">400</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p7639433202219">badRequest</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p3049090151624">Request error.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row27441815151624"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p8194509151624">401</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p18639103312225">unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p59775492151624">Authentication failed.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row1108519151624"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p22681218151624">403</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p26391233102211">userDisabled</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p25239345151624">You do not have the permission to perform the operation.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row25827516151624"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p11654021151624">404</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p1163943313228">Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p4451606151624">The requested page does not exist.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row40064457151624"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p23995610151624">500</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p96391733112217">authFault</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p64596296151624">System error.</p>
</td>
</tr>
<tr id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_row44495757151624"><td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.6.2.2.1.1.4.1.1 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p47386577151624">503</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.6.2.2.1.1.4.1.2 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_p1864093382212">serviceUnavailable</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.6.2.2.1.1.4.1.3 "><p id="elb_jd_pe_0001__en-us_topic_0096561521_en-us_topic_0020100174_p13107492151624">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</li></ul>
<strong>Parent topic:</strong> <a href="elb_jd_pe_0000.html">Quota</a>