forked from docs/doc-exports
wangdengke2
1ddaec1a62
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
158 lines
13 KiB
HTML
158 lines
13 KiB
HTML
<a name="rds_15_0001"></a><a name="rds_15_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying Resource Quotas</h1>
|
|
<div id="body0000002475099246"><div class="section" id="rds_15_0001__section61759636"><h4 class="sectiontitle">Function</h4><p id="rds_15_0001__p4725737717262">This API is used to query resource quotas in a project.</p>
|
|
<ul id="rds_15_0001__ul12259155218373"><li id="rds_15_0001__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_15_0001__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_15_0001__section18965813"><h4 class="sectiontitle">URI</h4><ul id="rds_15_0001__ul13194498"><li id="rds_15_0001__li41603465301">URI format<p id="rds_15_0001__p11160246123012"><a name="rds_15_0001__li41603465301"></a><a name="li41603465301"></a>GET https://{<em id="rds_15_0001__i11252164981618">Endpoint</em>}/v3/{project_id}/quotas</p>
|
|
</li></ul>
|
|
<ul id="rds_15_0001__ul55999443"><li id="rds_15_0001__li21405046">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_15_0001__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_15_0001__row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_15_0001__p10809459"><strong id="rds_15_0001__b1768014488532">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_15_0001__p3150961"><strong id="rds_15_0001__b28871352145316">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_15_0001__p53901255"><strong id="rds_15_0001__b1881015345310">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_15_0001__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_15_0001__p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_15_0001__p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_15_0001__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_15_0001__p186761044260">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_15_0001__section36474591"><h4 class="sectiontitle">Request</h4><ul id="rds_15_0001__ul1677317341210"><li id="rds_15_0001__li1830813567439">Pequest parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_15_0001__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_15_0001__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_15_0001__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_15_0001__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_15_0001__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_15_0001__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_15_0001__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_15_0001__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_15_0001__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_15_0001__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_15_0001__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_15_0001__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_15_0001__ul14221437241"><li id="rds_15_0001__li4411135064210">URI Example<pre class="screen" id="rds_15_0001__screen11938114112219">GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/quotas</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_15_0001__section59835867"><h4 class="sectiontitle">Response</h4><ul id="rds_15_0001__ul396612717394"><li id="rds_15_0001__li49661427193912">Normal Response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_15_0001__table29752153" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_15_0001__row62070345"><th align="left" class="cellrowborder" valign="top" width="23.880000000000003%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_15_0001__p61642077"><strong id="rds_15_0001__b1461692315193">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.119999999999997%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_15_0001__p26952341"><strong id="rds_15_0001__b728118195615">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_15_0001__p35656026"><strong id="rds_15_0001__b16761211868">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_15_0001__row49943891183823"><td class="cellrowborder" valign="top" width="23.880000000000003%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_15_0001__p186111553257">quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.119999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_15_0001__p28299952183823">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_15_0001__p1494115219428">Specifies the objects in the quota list.</p>
|
|
<p id="rds_15_0001__p9886152615558">For details, see <a href="#rds_15_0001__table136451019132019">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_15_0001__table136451019132019"></a><a name="table136451019132019"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_15_0001__table136451019132019" frame="border" border="1" rules="all"><caption><b>Table 4 </b>quotas field data structure description</caption><thead align="left"><tr id="rds_15_0001__row166461119162020"><th align="left" class="cellrowborder" valign="top" width="23.880000000000003%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_15_0001__p1064681915209"><strong id="rds_15_0001__b116409426197">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.119999999999997%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_15_0001__p19646171992011"><strong id="rds_15_0001__b568132817618">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_15_0001__p16461119122018"><strong id="rds_15_0001__b727163013611">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_15_0001__row16465196207"><td class="cellrowborder" valign="top" width="23.880000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_15_0001__p19599141313292">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.119999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_15_0001__a9a9492e05cb648e885d1e747a339d04d">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_15_0001__p166019134297">Indicates the resource list objects.</p>
|
|
<p id="rds_15_0001__p74052342429">For details, see <a href="#rds_15_0001__table1298224684119">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_15_0001__table1298224684119"></a><a name="table1298224684119"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_15_0001__table1298224684119" frame="border" border="1" rules="all"><caption><b>Table 5 </b>resources field data structure description</caption><thead align="left"><tr id="rds_15_0001__row1098364644110"><th align="left" class="cellrowborder" valign="top" width="23.880000000000003%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="rds_15_0001__p14983174614417"><strong id="rds_15_0001__b11743175271916">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.119999999999997%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="rds_15_0001__p1798334664114"><strong id="rds_15_0001__b1218716381967">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="rds_15_0001__p69839464416"><strong id="rds_15_0001__b14507840669">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_15_0001__row5983164614411"><td class="cellrowborder" valign="top" width="23.880000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_15_0001__p13604813132910">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.119999999999997%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_15_0001__p13604191372916">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_15_0001__p15604141317295">Indicates the project resource quota.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_15_0001__row8726091464"><td class="cellrowborder" valign="top" width="23.880000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_15_0001__p1960514137293">used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.119999999999997%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_15_0001__p1760591362915">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_15_0001__p176062137295">Indicates the number of used resources.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_15_0001__row150821316467"><td class="cellrowborder" valign="top" width="23.880000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_15_0001__p56061113112912">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.119999999999997%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_15_0001__p2060721382911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_15_0001__p128673619473">Indicates the project resource type.</p>
|
|
<p id="rds_15_0001__p7607113182912"><strong id="rds_15_0001__b1499054716207">instance</strong>: instance resources</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_15_0001__li24348422172618">Example normal response<pre class="screen" id="rds_15_0001__screen20393162314919">{
|
|
"quotas" : {
|
|
"resources" : [ {
|
|
"quota" : 100,
|
|
"used" : 1,
|
|
"type" : "instance"
|
|
} ]
|
|
}
|
|
}</pre>
|
|
</li><li id="rds_15_0001__li8200143916396">Abnormal Response<p id="rds_15_0001__p29415884"><a name="rds_15_0001__li8200143916396"></a><a name="li8200143916396"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_15_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_15_0001__en-us_topic_0032347778_ul7858132212142"><li id="rds_15_0001__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_15_0001__en-us_topic_0032347778_p1040982941020"><a name="rds_15_0001__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_15_0001__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_15_0001__en-us_topic_0032347778_p0723374409"><a name="rds_15_0001__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_15_0001__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_15_0001__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_15_0000.html">Quota Management</a></div>
|
|
</div>
|
|
</div>
|
|
|