forked from docs/doc-exports
Ru, Li Yi
37b97ffc06
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
155 lines
10 KiB
HTML
155 lines
10 KiB
HTML
<a name="ShowQuotas"></a><a name="ShowQuotas"></a>
|
|
|
|
<h1 class="topictitle1">Querying Quota</h1>
|
|
<div id="body23551040121214"><div class="section" id="ShowQuotas__section1435514019123"><h4 class="sectiontitle">Function</h4><p id="ShowQuotas__p73571040201211">This API is used to query <span id="ShowQuotas__text134741732134016">GeminiDB</span> resource quotas of a tenant.</p>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section53612409128"><h4 class="sectiontitle">URI</h4><p id="ShowQuotas__p18362940161213">GET https://{Endpoint}/v3/{project_id}/quotas</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__table1336644051211" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ShowQuotas__row9364104051213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowQuotas__p53671340191210">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowQuotas__p1236934081213">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowQuotas__p163702408127">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowQuotas__p133711440101213">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowQuotas__row3364184015121"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowQuotas__p3372104015122">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowQuotas__p737434091214">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowQuotas__p13375204031214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowQuotas__p3377440181214">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section7378040131211"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowQuotas__row738020402129"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowQuotas__p133825403124">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowQuotas__p738354017126">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowQuotas__p11385840181210">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowQuotas__p438664011121">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowQuotas__row183804406129"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowQuotas__p1638811403126">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowQuotas__p11390940151212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowQuotas__p039111403123">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowQuotas__p639254071211">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section1539416408127"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowQuotas__p19398040151211"><strong id="ShowQuotas__b762712419528">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__response_ShowQuotasResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowQuotas__row1240094081214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowQuotas__p1140214011219">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowQuotas__p840344019124">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowQuotas__p5405194071211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowQuotas__row1940014061220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowQuotas__p8406114016120">quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowQuotas__p11407134011217"><a href="#ShowQuotas__response_ShowResourcesListResponseBody">ShowResourcesListResponseBody</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowQuotas__p54099405122">Quota information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowQuotas__response_ShowResourcesListResponseBody"></a><a name="response_ShowResourcesListResponseBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__response_ShowResourcesListResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ShowResourcesListResponseBody</caption><thead align="left"><tr id="ShowQuotas__row241014011217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowQuotas__p144121040111210">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowQuotas__p18415124012122">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowQuotas__p4416104001219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowQuotas__row14101640101213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowQuotas__p14181540201215">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowQuotas__p54194407126">Array of <a href="#ShowQuotas__response_ShowResourcesDetailResponseBody">ShowResourcesDetailResponseBody</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowQuotas__p6421184061220">All resources.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowQuotas__response_ShowResourcesDetailResponseBody"></a><a name="response_ShowResourcesDetailResponseBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__response_ShowResourcesDetailResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ShowResourcesDetailResponseBody</caption><thead align="left"><tr id="ShowQuotas__row19422204012129"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowQuotas__p9425540191215">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowQuotas__p742674013121">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowQuotas__p15427940131212">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowQuotas__row44221540171214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowQuotas__p242917407126">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowQuotas__p4431194018125">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowQuotas__p5432174015122">Quota resource type. Only the instance type is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowQuotas__row5422124010129"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowQuotas__p143354010125">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowQuotas__p17435144081217">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowQuotas__p11436640181212">Current quota.</p>
|
|
<p id="ShowQuotas__p3437184016128">If this parameter is set to <strong id="ShowQuotas__b8492115612539">0</strong>, no quantity limit is set for resources.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowQuotas__row44222040131218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowQuotas__p6438114015122">used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowQuotas__p74401040171217">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowQuotas__p18441144014126">Number of used resources.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section14421140181215"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="ShowQuotas__p0937714163013">URI example<pre class="screen" id="ShowQuotas__screen156548483178">GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/quotas</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section19451134011125"><h4 class="sectiontitle">Example Responses</h4><p id="ShowQuotas__p5453124021218"><strong id="ShowQuotas__b5336163435418">Status code: 200</strong></p>
|
|
<p id="ShowQuotas__p74541740151210">Success</p>
|
|
<pre class="screen" id="ShowQuotas__screen174561440131217">{
|
|
"quotas" : {
|
|
"resources" : [ {
|
|
"type" : "instance",
|
|
"quota" : 200,
|
|
"used" : 58
|
|
} ]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ShowQuotas__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ShowQuotas__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Quotas</a></div>
|
|
</div>
|
|
</div>
|
|
|