forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
228 lines
17 KiB
HTML
228 lines
17 KiB
HTML
<a name="dcs-api-0312036"></a><a name="dcs-api-0312036"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Quota of a Tenant</h1>
|
|
<div id="body44903457"><div class="section" id="dcs-api-0312036__section164151825713"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312036__p038416110573">This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312036__section14354165101817"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312036__p719318312310">GET /v1.0/{project_id}/quota</p>
|
|
<div class="p" id="dcs-api-0312036__p108011920113911"><a href="#dcs-api-0312036__table13653920143919">Table 1</a> describes the parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312036__table13653920143919"></a><a name="table13653920143919"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312036__table13653920143919" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312036__row13652172011391"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312036__p0652102011396">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312036__p16521202391">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312036__p765292023914">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312036__p136521420153919">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312036__row176531320103915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312036__p2065202017391">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312036__p0653920173910">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312036__p4653020183913">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312036__p96533202399">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312036__section116044010182"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312036__p145121018133112"><strong id="dcs-api-0312036__b951048145116">Request parameters</strong></p>
|
|
<p id="dcs-api-0312036__p1751311893113">None</p>
|
|
<p id="dcs-api-0312036__p2051316188313"><strong id="dcs-api-0312036__b7326181118519">Example request</strong></p>
|
|
<p id="dcs-api-0312036__p6513101853113">None</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312036__section66414611916"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312036__p14461155284215"><strong id="dcs-api-0312036__b866621715512">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312036__p4528524153911"><a href="#dcs-api-0312036__table114165246391">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312036__table114165246391"></a><a name="table114165246391"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312036__table114165246391" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312036__row104150248391"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.2.5.1.1"><p id="dcs-api-0312036__p12415924193920">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.2.5.1.2"><p id="dcs-api-0312036__p144151224163910">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.3.2.2.5.1.3"><p id="dcs-api-0312036__p54593291407">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.4.3.2.2.5.1.4"><p id="dcs-api-0312036__p2415182419396">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312036__row13415324183915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.5.1.1 "><p id="dcs-api-0312036__p441552483916">quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.2.5.1.2 "><p id="dcs-api-0312036__p06451925192319">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.2.5.1.3 "><p id="dcs-api-0312036__p2046020291503">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.3.2.2.5.1.4 "><p id="dcs-api-0312036__p15415102415391">Quota information. For details, see <a href="#dcs-api-0312036__table1341618240392">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312036__table1341618240392"></a><a name="table1341618240392"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312036__table1341618240392" frame="border" border="1" rules="all"><caption><b>Table 3 </b>quotas parameter description</caption><thead align="left"><tr id="dcs-api-0312036__row241652418392"><th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.4.4.2.5.1.1"><p id="dcs-api-0312036__p0416122417395">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.4.2.5.1.2"><p id="dcs-api-0312036__p8416624203915">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.4.2.5.1.3"><p id="dcs-api-0312036__p1865085215017">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.4.4.2.5.1.4"><p id="dcs-api-0312036__p6416152423910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312036__row134163246394"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dcs-api-0312036__p104161424133913">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dcs-api-0312036__p341642453911">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dcs-api-0312036__p765019524010">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dcs-api-0312036__p124164242391">List of quotas. For details, see <a href="#dcs-api-0312036__table164180248392">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row84207492518"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dcs-api-0312036__p44203482511">resource_user</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dcs-api-0312036__p17420134112519">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dcs-api-0312036__p156511552305">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dcs-api-0312036__p1242034112513">Information about a resource tenant For details, see <a href="#dcs-api-0312036__table1641811248397">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312036__table164180248392"></a><a name="table164180248392"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312036__table164180248392" frame="border" border="1" rules="all"><caption><b>Table 4 </b>resources parameter description</caption><thead align="left"><tr id="dcs-api-0312036__row84161724193917"><th align="left" class="cellrowborder" valign="top" width="24.752475247524753%" id="mcps1.3.4.5.2.4.1.1"><p id="dcs-api-0312036__p34161724103916">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.65346534653465%" id="mcps1.3.4.5.2.4.1.2"><p id="dcs-api-0312036__p24161224173920">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.59405940594059%" id="mcps1.3.4.5.2.4.1.3"><p id="dcs-api-0312036__p1541632411391">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312036__row94171524133918"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312036__p12417824113917">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312036__p641792411399">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.59405940594059%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312036__p18652185613414">Maximum number of instances that can be created and maximum allowed total memory.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row441752415393"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312036__p341772463919">used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312036__p1341722443920">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.59405940594059%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312036__p841732473916">Number of created instances and used memory.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row143604574285"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312036__p19651145182911">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312036__p14651125162918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.59405940594059%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312036__p1065165202911">Values:</p>
|
|
<ul id="dcs-api-0312036__ul68511652669"><li id="dcs-api-0312036__li1285111528612"><strong id="dcs-api-0312036__b16686312155213">instances</strong>: indicates the instance quota.</li><li id="dcs-api-0312036__li38511521562"><strong id="dcs-api-0312036__b88151814195218">ram</strong>: indicates the memory quota.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row1141719245396"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312036__p341792416391">unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312036__p441715243393">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.59405940594059%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312036__p19709101812711">Resource unit.</p>
|
|
<ul id="dcs-api-0312036__ul171513818816"><li id="dcs-api-0312036__li10151581184">When <strong id="dcs-api-0312036__b8123112911526">type</strong> is set to <strong id="dcs-api-0312036__b91247297524">instance</strong>, no value is returned.</li><li id="dcs-api-0312036__li201517817817">When <strong id="dcs-api-0312036__b20493173112521">type</strong> is set to <strong id="dcs-api-0312036__b154941831155211">ram</strong>, <strong id="dcs-api-0312036__b64951831125220">GB</strong> is returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row74177249394"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312036__p4417202413911">max</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312036__p134171724193914">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.59405940594059%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="dcs-api-0312036__ul35767124811"><li id="dcs-api-0312036__li45765121184">Indicates the maximum limit of instance quota when <strong id="dcs-api-0312036__b1370753417528">type</strong> is set to <strong id="dcs-api-0312036__b12708934185211">instance</strong>.</li><li id="dcs-api-0312036__li1357691215817">Indicates the maximum limit of memory quota when <strong id="dcs-api-0312036__b278614019529">type</strong> is set to <strong id="dcs-api-0312036__b117871340185214">ram</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row13418152412393"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312036__p341712483915">min</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.65346534653465%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312036__p14418132493912">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.59405940594059%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="dcs-api-0312036__ul6173136347"><li id="dcs-api-0312036__li917383123415">Indicates the minimum limit of instance quota when <strong id="dcs-api-0312036__b988410517524">type</strong> is set to <strong id="dcs-api-0312036__b988545110527">instance</strong>.</li><li id="dcs-api-0312036__li2017410314341">Indicates the minimum limit of memory quota when <strong id="dcs-api-0312036__b1020695411521">type</strong> is set to <strong id="dcs-api-0312036__b1820725425220">ram</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312036__table1641811248397"></a><a name="table1641811248397"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312036__table1641811248397" frame="border" border="1" rules="all"><caption><b>Table 5 </b>resource_user parameter description</caption><thead align="left"><tr id="dcs-api-0312036__row134181624153915"><th align="left" class="cellrowborder" valign="top" width="24.752475247524753%" id="mcps1.3.4.6.2.4.1.1"><p id="dcs-api-0312036__p1541872443910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.772277227722775%" id="mcps1.3.4.6.2.4.1.2"><p id="dcs-api-0312036__p841810249390">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.4.6.2.4.1.3"><p id="dcs-api-0312036__p15418172443913">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312036__row14418724113912"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dcs-api-0312036__p134188244395">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.772277227722775%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dcs-api-0312036__p6418132417393">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dcs-api-0312036__p1441818240395">Resource tenant ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312036__row19418132443915"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dcs-api-0312036__p64181324183914">tenant_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.772277227722775%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dcs-api-0312036__p19826101016912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dcs-api-0312036__p19418152423912">Resource tenant name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="msonormal" id="dcs-api-0312036__p12743639194317"><strong id="dcs-api-0312036__b117198655311">Example response</strong><pre class="screen" id="dcs-api-0312036__screen17605522102214">{
|
|
"quotas": {
|
|
"resources": [
|
|
{
|
|
"quota": 10,
|
|
"used": 3,
|
|
"type": "instance",
|
|
"min": 1,
|
|
"max": 10,
|
|
"unit": null
|
|
},
|
|
{
|
|
"quota": 800,
|
|
"used": 22,
|
|
"type": "ram",
|
|
"min": 1,
|
|
"max": 800,
|
|
"unit": "GB"
|
|
}
|
|
],
|
|
"resource_user": {
|
|
"tenant_id": "836152f9838a44089f40f3cf6fd432bf",
|
|
"tenant_name": "op_svc_dcs_003"
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312036__section29701335151315"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312036__p8970163531315"><a href="#dcs-api-0312036__table597043515135">Table 6</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312036__table597043515135"></a><a name="table597043515135"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312036__table597043515135" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312036__row3970103581319"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312036__p4970163512138">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312036__p14970113519134">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312036__row1970935151313"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312036__p17970163551313">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312036__p597033518133">Tenant quota queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312038.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|