vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/as/api-ref/as_06_0701.html
Zaoxu, Li eda4b9181d AS API DOC 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-09-19 11:04:13 +00:00

258 lines
17 KiB
HTML
Raw Blame History

<a name="as_06_0701"></a><a name="as_06_0701"></a>
<h1 class="topictitle1">Querying AS Quotas</h1>
<div id="body1451530017879"><div class="section" id="as_06_0701__section11009764"><h4 class="sectiontitle">Function</h4><p id="as_06_0701__p10578662">This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.</p>
</div>
<div class="section" id="as_06_0701__section31979016"><h4 class="sectiontitle">URI</h4><p id="as_06_0701__p17425743">GET /autoscaling-api/v1/{project_id}/quotas</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0701__table2199097" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="as_06_0701__row41000636"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.5.1.1"><p id="as_06_0701__p32717189"><strong id="as_06_0701__b13990340838">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.2.5.1.2"><p id="as_06_0701__p32846614">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.5.1.3"><p id="as_06_0701__p43330072">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.2.3.2.5.1.4"><p id="as_06_0701__p20074930"><strong id="as_06_0701__b12998154316311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0701__row15456653"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0701__p44029393">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0701__p9611044">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0701__p40297137">String</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0701__p36520930">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="as_06_0701__section19375690"><h4 class="sectiontitle">Request</h4><p id="as_06_0701__p60400126203515">None</p>
</div>
<div class="section" id="as_06_0701__section171361014185610"><h4 class="sectiontitle">Example Request</h4><p id="as_06_0701__p15614505203519">This example queries the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.</p>
<pre class="screen" id="as_06_0701__screen2194471345">GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas</pre>
</div>
<div class="section" id="as_06_0701__section40163483"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0701__table51227795" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="as_06_0701__row28165387"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.2.4.1.1"><p id="as_06_0701__p66803900"><strong id="as_06_0701__b57666451535">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.2.2.4.1.2"><p id="as_06_0701__p42406858">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62%" id="mcps1.3.5.2.2.4.1.3"><p id="as_06_0701__p12403484"><strong id="as_06_0701__b915144719319">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0701__row65158171"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0701__p43320494">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0701__p12631120171"><a href="#as_06_0701__table5036780310489">quotas</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0701__p19726002">Specifies quota details. For details, see <a href="#as_06_0701__table5036780310489">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="as_06_0701__table5036780310489"></a><a name="table5036780310489"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0701__table5036780310489" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="as_06_0701__b158125514343">quotas</strong> field description</caption><thead align="left"><tr id="as_06_0701__r1f3f90a6acc94015acc80b9d6b53f072"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="as_06_0701__ad0d15c1370cb450fb7e6011b8baff160">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.3.2.4.1.2"><p id="as_06_0701__a2273dfb9dd3341b0b5cbf801a0aa70fc">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.5.3.2.4.1.3"><p id="as_06_0701__a479b45e1fbfc44118151c43b5ecb82f1">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0701__rdd24623b54f94a86b0f655ec659180e9"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0701__ab9c8eb8b964943509fca83cc70a4e489">resources</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0701__a43cc5f338c7e429c861f7dbb2dcb3229">Array of <a href="#as_06_0701__table61002694">resources</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0701__a5c153a8f0b8d4f26af1405cdcbcec1cc">Specifies resources. For details, see <a href="#as_06_0701__table61002694">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="as_06_0701__table61002694"></a><a name="table61002694"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0701__table61002694" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="as_06_0701__b1784415227355">resources</strong> field description</caption><thead align="left"><tr id="as_06_0701__row47328638"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.5.4.2.4.1.1"><p id="as_06_0701__p8414476">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.5.4.2.4.1.2"><p id="as_06_0701__p10483995">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62%" id="mcps1.3.5.4.2.4.1.3"><p id="as_06_0701__p43897299">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0701__row66020315"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0701__p46045275">type</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0701__p38679804">String</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0701__p46056421">Specifies the quota type.</p>
<ul id="as_06_0701__ua99da6c954d14b9f8e73af19c844fac9"><li id="as_06_0701__l45422e4f822946d7966e6cddbc896f0e"><strong id="as_06_0701__b842352706185635">scaling_Group</strong>: AS group quota</li><li id="as_06_0701__la4172620632647b8a4a815f09dc0e3d4"><strong id="as_06_0701__b842352706185647">scaling_Config</strong>: AS configuration quota</li><li id="as_06_0701__li652654918740"><strong id="as_06_0701__b842352706185656">scaling_Policy</strong>: AS policy quota</li><li id="as_06_0701__li5873894118740"><strong id="as_06_0701__b842352706185737">scaling_Instance</strong>: instance quota</li><li id="as_06_0701__li2761344418854"><strong id="as_06_0701__b1750820364133">bandwidth_scaling_policy</strong>: bandwidth scaling policy quota.</li></ul>
</td>
</tr>
<tr id="as_06_0701__row11854613"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0701__p20699582">used</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0701__p66053444">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0701__p48728718">Specifies the used amount of the quota.</p>
<p id="as_06_0701__p60330192195232">When <strong id="as_06_0701__b84235270615576">type</strong> is set to <strong id="as_06_0701__b842352706155714">scaling_Policy</strong> or <strong id="as_06_0701__b842352706155718">scaling_Instance</strong>, this parameter is reserved, and the system returns <strong id="as_06_0701__b842352706163219">-1</strong> as the parameter value. You can query the used quota of AS policies and AS instances in a specified AS group. For details, see <a href="as_06_0702.html">Querying AS Policy and Instance Quotas</a>.</p>
</td>
</tr>
<tr id="as_06_0701__row35905280"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0701__p22646572">quota</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0701__p22433040">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0701__p5136981">Specifies the total quota.</p>
</td>
</tr>
<tr id="as_06_0701__row14705260193547"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0701__p50275448193547">max</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0701__p45779455193547">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0701__p17148395193547">Specifies the quota upper limit.</p>
</td>
</tr>
<tr id="as_06_0701__row99575218455"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0701__p1775171184518">min</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0701__p174551858104615">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0701__p1595716216452">Specifies the quota lower limit.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="as_06_0701__section326915491565"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="as_06_0701__screen290852799579">{
"quotas": {
"resources": [
{
"type": "scaling_Group",
"used": 2,
"quota": 25,
"max": 50,
"min": 0
},
{
"type": "scaling_Config",
"used": 3,
"quota": 100,
"max": 200,
"min": 0
},
{
"type": "scaling_Policy",
"used": -1,
"quota": 50,
"max": 50,
"min": 0
},
{
"type": "scaling_Instance",
"used": -1,
"quota": 200,
"max": 1000,
"min": 0
},
{
"type": "bandwidth_scaling_policy",
"used": 1,
"quota": 10,
"max": 100,
"min": 0
}
]
}
}</pre>
</div>
<div class="section" id="as_06_0701__section25927028"><h4 class="sectiontitle">Returned Values</h4><ul id="as_06_0701__ul32267243"><li id="as_06_0701__li21969731">Normal<p id="as_06_0701__p63509856"><a name="as_06_0701__li21969731"></a><a name="li21969731"></a>200</p>
</li><li id="as_06_0701__li34717793">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0701__table44024689" frame="border" border="1" rules="all"><thead align="left"><tr id="as_06_0701__row17847776"><th align="left" class="cellrowborder" valign="top" width="44.18%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="as_06_0701__p36383728">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.82%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="as_06_0701__p61400865">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0701__row7414170"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p63676932">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p57557895">The server failed to process the request.</p>
</td>
</tr>
<tr id="as_06_0701__row48259009"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p16665627">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p7738529">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="as_06_0701__row2537905"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p4243749">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p8199418">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="as_06_0701__row6685904"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p4687385">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p44133910">The server could not find the requested page.</p>
</td>
</tr>
<tr id="as_06_0701__row61660876"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p28475059">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p24778434">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="as_06_0701__row21679321"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p11194552">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p34343508">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="as_06_0701__row40656116"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p4811061">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p54151655">You must use the proxy server for authentication to process the request.</p>
</td>
</tr>
<tr id="as_06_0701__row17602849"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p16544703">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p65052577">The request timed out.</p>
</td>
</tr>
<tr id="as_06_0701__row48602288"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p44471219">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p45399024">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="as_06_0701__row5938035"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p11218807">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p36308168">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="as_06_0701__row58338056"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p27762102">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p34137829">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="as_06_0701__row38805013"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p56198311">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p55769358">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="as_06_0701__row32162181"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p54999878">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p25805135">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="as_06_0701__row30919631"><td class="cellrowborder" valign="top" width="44.18%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0701__p21462168">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="55.82%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0701__p60714046">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="as_06_0701__section17669131616110"><h4 class="sectiontitle">Error Codes</h4><p id="as_06_0701__p172692548116">See <a href="as_07_0102.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="as_06_0700.html">Quotas</a></div>
</div>
</div>
View Git Blame Copy Permalink