doc-exports/docs/ecs/api-ref/en-us_topic_0020212674.html
Artem Goncharov 3196b64bfc
move doc sources to other location (#3)
move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>
2022-04-27 16:24:25 +00:00

238 lines
18 KiB
HTML

<a name="EN-US_TOPIC_0020212674"></a><a name="EN-US_TOPIC_0020212674"></a>
<h1 class="topictitle1">Querying Tenant Quotas</h1>
<div id="body17690949"><div class="section" id="EN-US_TOPIC_0020212674__section7764884"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020212674__p23680747">This API is used to query the quotas of all resources for a specified tenant, including used quotas.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section2775100"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020212674__p38567085163342">GET /v1/{project_id}/cloudservers/limits</p>
<div class="p" id="EN-US_TOPIC_0020212674__p103939321292"><a href="#EN-US_TOPIC_0020212674__table23262209">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212674__table23262209"></a><a name="table23262209"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212674__table23262209" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212674__row32406826"><th align="left" class="cellrowborder" valign="top" width="16.61%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0020212674__p7707213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.54%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0020212674__p20304554">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.85%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0020212674__p34056167">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212674__row7086124"><td class="cellrowborder" valign="top" width="16.61%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p37105186">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.54%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p52730096">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="65.85%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p37593705">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section24975902"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0020212674__p9533937">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section23456533"><h4 class="sectiontitle">Response</h4><div class="p" id="EN-US_TOPIC_0020212674__p7436108143012"><a href="#EN-US_TOPIC_0020212674__table6147620">Table 2</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212674__table6147620"></a><a name="table6147620"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212674__table6147620" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0020212674__row63161481"><th align="left" class="cellrowborder" valign="top" width="16.85%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0020212674__p15806308">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.23%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0020212674__p21995508">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.92%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0020212674__p36805753">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212674__row28476039"><td class="cellrowborder" valign="top" width="16.85%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p24857797">absolute</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p17467122">Object</p>
</td>
<td class="cellrowborder" valign="top" width="65.92%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p49956928">Specifies tenant quotas. For details, see <a href="#EN-US_TOPIC_0020212674__table7714075">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212674__table7714075"></a><a name="table7714075"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212674__table7714075" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0020212674__b8423527061138">absolute</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212674__row63715136"><th align="left" class="cellrowborder" valign="top" width="19.470000000000002%" id="mcps1.3.4.2.3.2.4.1.1"><p id="EN-US_TOPIC_0020212674__p1243814208352">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.56%" id="mcps1.3.4.2.3.2.4.1.2"><p id="EN-US_TOPIC_0020212674__p943862010355">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.97%" id="mcps1.3.4.2.3.2.4.1.3"><p id="EN-US_TOPIC_0020212674__p1443832011351">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212674__row42383756"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p10532193">maxTotalInstances</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p46701637">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p21300044">Specifies the maximum number of <span id="EN-US_TOPIC_0020212674__text5605428377">ECS</span>s you can use.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row57482668"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p25584516">maxTotalCores</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p20741957">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p21392630">Specifies the maximum number of CPU cores you can use.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row58315944"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p25971051">maxTotalRAMSize</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p6661465">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p24370177">Specifies the maximum memory space (MB) you can use.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row18005001"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p49119006">maxTotalKeypairs</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p13038474">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p42697780">Specifies the maximum number of SSH key pairs you can use.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row48735703"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p55277862">maxServerMeta</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p21756767">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p22991320">Specifies the maximum length of the metadata you can use.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row5595289"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p50565259">maxPersonality</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p39551712">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p43495860">Specifies the maximum number of files that can be injected.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row55918423"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p33098452">maxPersonalitySize</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p61770902">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p940305">Specifies the maximum size (byte) of the file to be injected.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row56010681154433"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p34334083154433">maxServerGroups</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p29597354154433">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p48575502154433">Specifies the maximum number of server groups.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row6104724715477"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p4587998315477">maxServerGroupMembers</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p2529112315477">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p3531507615477">Specifies the maximum number of <span id="EN-US_TOPIC_0020212674__text983537135120">ECS</span>s in an <span id="EN-US_TOPIC_0020212674__text1243195820204">ECS</span> group.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row3499539015481"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p1605434815481">totalServerGroupsUsed</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p2533385115481">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p3877608315481">Specifies the number of used server groups.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row8462746"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p14393865">maxSecurityGroups</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p15982473">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p41389494">Specifies the maximum number of security groups you can use.</p>
<div class="note" id="EN-US_TOPIC_0020212674__note8411879113615"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020212674__p8598055113615">The quota complies with the VPC quota limit.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row36961130"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p41061555">maxSecurityGroupRules</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p29888320">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p45313516">Specifies the maximum number of security group rules that you can configure in a security group.</p>
<div class="note" id="EN-US_TOPIC_0020212674__note32309229113621"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020212674__p22347611113621">The quota complies with the VPC quota limit.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row5168462"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p15992282">maxTotalFloatingIps</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p34210755">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p42252410">Specifies the maximum number of floating IP addresses you can use.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row44727375"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p66147589">maxImageMeta</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p1311131">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p16290985">Specifies the maximum length of the image metadata.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row12401140"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p64968253">totalInstancesUsed</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p48312784">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p54975040">Specifies the number of used <span id="EN-US_TOPIC_0020212674__text119266533712">ECS</span>s.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row25013317"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p12812809">totalCoresUsed</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p44542441">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p57858440">Specifies the number of the used CPU cores.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row50963915"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p34436465">totalRAMUsed</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p49214446">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p41198408">Specifies the used memory size (MB).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row35241358"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p35977726">totalSecurityGroupsUsed</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p27989608">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p3330249">Specifies the number of used security groups.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212674__row29972245"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212674__p11832760">totalFloatingIpsUsed</p>
</td>
<td class="cellrowborder" valign="top" width="14.56%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212674__p56892511">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.97%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212674__p1362898">Specifies the number of used floating IP addresses.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section59014260171"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0020212674__screen08389511593">GET https://{endpoint}/v1/{project_id}/cloudservers/limits</pre>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section15363155313399"><h4 class="sectiontitle">Example Response</h4><div class="p" id="EN-US_TOPIC_0020212674__p9849194015179">Example response<pre class="screen" id="EN-US_TOPIC_0020212674__screen5744552620315">{
"absolute": {
"maxServerMeta": 128,
"maxPersonality": 5,
"maxImageMeta": 128,
"maxPersonalitySize": 10240,
"maxSecurityGroupRules": 20,
"maxTotalKeypairs": -1,
"totalRAMUsed": 75776,
"totalInstancesUsed": 21,
"maxSecurityGroups": 10,
"totalFloatingIpsUsed": 0,
"maxTotalCores": 20480,
"totalSecurityGroupsUsed": 1,
"maxTotalFloatingIps": 10,
"maxTotalInstances": 2048,
"totalCoresUsed": 40,
"maxTotalRAMSize": 25165824,
"maxServerGroups": 10,
"maxServerGroupMembers": 16,
"totalServerGroupsUsed": 2
}
}</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section9782209"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0020212674__p54029094">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212674__section85821649202813"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0020212674__p7233105282813">See <a href="en-us_topic_0022067717.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0020212673.html">Tenant Quota Management</a></div>
</div>
</div>