Files
doc-exports/docs/geminidb/api-ref/topic_300000018.html
wangdengke2 59805c5073 GeminiDB_API
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>
2026-03-12 09:56:41 +00:00

279 lines
19 KiB
HTML

<a name="topic_300000018"></a><a name="topic_300000018"></a>
<h1 class="topictitle1">Querying Enterprise Project Quotas</h1>
<div id="body0000001387061706"><div class="section" id="topic_300000018__section9244214185213"><h4 class="sectiontitle">Function</h4><p id="topic_300000018__p44582014195212">This API is used to query enterprise project quotas.</p>
</div>
<div class="section" id="topic_300000018__section1824518149525"><h4 class="sectiontitle">URI</h4><p id="topic_300000018__p6458414185210">GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotas</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table9245171415212" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="topic_300000018__row44599147523"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="topic_300000018__p15459131410526">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="topic_300000018__p9459121416528">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="topic_300000018__p64591014165217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="topic_300000018__p2459214185210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row11459171417529"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="topic_300000018__p3459014145214">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="topic_300000018__p345971475215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="topic_300000018__p545911419522">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="topic_300000018__p3459141495220">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table52511114115217" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="topic_300000018__row94594143524"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="topic_300000018__p204591614125220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="topic_300000018__p19459514135211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="topic_300000018__p645951416526">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="topic_300000018__p4459151485219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row1459111465213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="topic_300000018__p84591814165212">enterprise_project_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="topic_300000018__p1446021411528">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="topic_300000018__p124601514135214">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="topic_300000018__p1746010142523">Enterprise project name. Fuzzy search is supported. If this parameter is not specified, all enterprise project quotas are returned.</p>
</td>
</tr>
<tr id="topic_300000018__row446013147528"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="topic_300000018__p1746061415527">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="topic_300000018__p13460201425216">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="topic_300000018__p1146011415522">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="topic_300000018__p9460131435211">Index offset.</p>
<ul id="topic_300000018__ul346081405219"><li id="topic_300000018__li12460151485212">The query starts from the next piece of data indexed by this parameter. The value is <strong id="topic_300000018__b3486184612169">0</strong> by default.</li><li id="topic_300000018__li2046051415529">The value must be a positive integer.</li></ul>
</td>
</tr>
<tr id="topic_300000018__row14601514165220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="topic_300000018__p44601147521">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="topic_300000018__p7460191445219">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="topic_300000018__p1846051445210">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="topic_300000018__p1460214125212">Maximum records to be queried.</p>
<ul id="topic_300000018__ul10460141415522"><li id="topic_300000018__li2460181465214">The value ranges from <strong id="topic_300000018__b1244963216177">1</strong> to <strong id="topic_300000018__b17450832141717">100</strong>.</li><li id="topic_300000018__li1546111475212">If this parameter is not transferred, the first 100 records are queried by default.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="topic_300000018__section7265161495212"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table72661814145214" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="topic_300000018__row1546181445212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="topic_300000018__p1461101416522">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="topic_300000018__p646121416527">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="topic_300000018__p184617145521">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="topic_300000018__p94614146524">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row104611147521"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="topic_300000018__p1346113149529">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="topic_300000018__p4461014205212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="topic_300000018__p04612147526">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="topic_300000018__p11461141445219">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="topic_300000018__section1027131414523"><h4 class="sectiontitle">Response Parameters</h4><p id="topic_300000018__p8461141411524"><strong id="topic_300000018__b5633155515172">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table72731914115215" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="topic_300000018__row5461141425212"><th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.4.3.2.4.1.1"><p id="topic_300000018__p164611914155218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.65%" id="mcps1.3.4.3.2.4.1.2"><p id="topic_300000018__p164621814125210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.38%" id="mcps1.3.4.3.2.4.1.3"><p id="topic_300000018__p1462201419528">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row16462121415521"><td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.3.2.4.1.1 "><p id="topic_300000018__p246210149521">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="37.65%" headers="mcps1.3.4.3.2.4.1.2 "><p id="topic_300000018__p646213140528">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="42.38%" headers="mcps1.3.4.3.2.4.1.3 "><p id="topic_300000018__p144621114125218">Total number of records</p>
</td>
</tr>
<tr id="topic_300000018__row5462141420526"><td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.3.2.4.1.1 "><p id="topic_300000018__p14621914145219">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="37.65%" headers="mcps1.3.4.3.2.4.1.2 "><p id="topic_300000018__p13462171485210">objects</p>
</td>
<td class="cellrowborder" valign="top" width="42.38%" headers="mcps1.3.4.3.2.4.1.3 "><p id="topic_300000018__p164622014185219">Enterprise project quotas. For details, see <a href="#topic_300000018__table18282101411527">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="topic_300000018__table18282101411527"></a><a name="table18282101411527"></a><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table18282101411527" frame="border" border="1" rules="all"><caption><b>Table 5 </b>NoSqlQueryEpsQuotaInfo</caption><thead align="left"><tr id="topic_300000018__row146271445214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="topic_300000018__p1946271435215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.83%" id="mcps1.3.4.4.2.4.1.2"><p id="topic_300000018__p194621114185220">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.17%" id="mcps1.3.4.4.2.4.1.3"><p id="topic_300000018__p1046331419526">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row154638147520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="topic_300000018__p1546331475215">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="35.83%" headers="mcps1.3.4.4.2.4.1.2 "><p id="topic_300000018__p13463111485216">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.4.4.2.4.1.3 "><p id="topic_300000018__p11463141435210">Enterprise project ID</p>
</td>
</tr>
<tr id="topic_300000018__row18463161425216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="topic_300000018__p146381419527">enterprise_project_name</p>
</td>
<td class="cellrowborder" valign="top" width="35.83%" headers="mcps1.3.4.4.2.4.1.2 "><p id="topic_300000018__p16463014185213">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.4.4.2.4.1.3 "><p id="topic_300000018__p64641314175217">Enterprise project name</p>
</td>
</tr>
<tr id="topic_300000018__row11464101475216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="topic_300000018__p1946411412522">quota</p>
</td>
<td class="cellrowborder" valign="top" width="35.83%" headers="mcps1.3.4.4.2.4.1.2 "><p id="topic_300000018__p1846413145525">object</p>
</td>
<td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.4.4.2.4.1.3 "><p id="topic_300000018__p19464171418528">Enterprise project quotas. For details, see <a href="#topic_300000018__table629161419521">Table 6</a>.</p>
</td>
</tr>
<tr id="topic_300000018__row4464514185216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="topic_300000018__p20464141412525">used</p>
</td>
<td class="cellrowborder" valign="top" width="35.83%" headers="mcps1.3.4.4.2.4.1.2 "><p id="topic_300000018__p1146421445216">object</p>
</td>
<td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.4.4.2.4.1.3 "><p id="topic_300000018__p1846421419527">Enterprise project quota used. For details, see <a href="#topic_300000018__table02981014125217">Table 7</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="topic_300000018__table629161419521"></a><a name="table629161419521"></a><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table629161419521" frame="border" border="1" rules="all"><caption><b>Table 6 </b>NoSqlEpsQuotaTotal</caption><thead align="left"><tr id="topic_300000018__row1346571445210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="topic_300000018__p19465161465210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.86%" id="mcps1.3.4.5.2.4.1.2"><p id="topic_300000018__p11465111465219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.14%" id="mcps1.3.4.5.2.4.1.3"><p id="topic_300000018__p34651514135212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row13465131412528"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="topic_300000018__p17465191419522">instance</p>
</td>
<td class="cellrowborder" valign="top" width="34.86%" headers="mcps1.3.4.5.2.4.1.2 "><p id="topic_300000018__p14651814195217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.14%" headers="mcps1.3.4.5.2.4.1.3 "><p id="topic_300000018__p346571413524">Instance quota</p>
</td>
</tr>
<tr id="topic_300000018__row174652147521"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="topic_300000018__p546620142525">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="34.86%" headers="mcps1.3.4.5.2.4.1.2 "><p id="topic_300000018__p10466121465217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.14%" headers="mcps1.3.4.5.2.4.1.3 "><p id="topic_300000018__p54661914125218">vCPU quota</p>
</td>
</tr>
<tr id="topic_300000018__row346615148521"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="topic_300000018__p10466151410526">ram</p>
</td>
<td class="cellrowborder" valign="top" width="34.86%" headers="mcps1.3.4.5.2.4.1.2 "><p id="topic_300000018__p164665148525">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.14%" headers="mcps1.3.4.5.2.4.1.3 "><p id="topic_300000018__p10466141415522">RAM quota</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="topic_300000018__table02981014125217"></a><a name="table02981014125217"></a><table cellpadding="4" cellspacing="0" summary="" id="topic_300000018__table02981014125217" frame="border" border="1" rules="all"><caption><b>Table 7 </b>NoSqlEpsQuotaUsed</caption><thead align="left"><tr id="topic_300000018__row13466201418521"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="topic_300000018__p1346651495214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.900000000000006%" id="mcps1.3.4.6.2.4.1.2"><p id="topic_300000018__p1146611411521">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.1%" id="mcps1.3.4.6.2.4.1.3"><p id="topic_300000018__p104661914165220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="topic_300000018__row24661114175213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="topic_300000018__p17466314125213">instance</p>
</td>
<td class="cellrowborder" valign="top" width="33.900000000000006%" headers="mcps1.3.4.6.2.4.1.2 "><p id="topic_300000018__p10466141425211">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.4.6.2.4.1.3 "><p id="topic_300000018__p246781410527">Used instance quota</p>
</td>
</tr>
<tr id="topic_300000018__row15467141485216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="topic_300000018__p74671214125214">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="33.900000000000006%" headers="mcps1.3.4.6.2.4.1.2 "><p id="topic_300000018__p1246718141524">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.4.6.2.4.1.3 "><p id="topic_300000018__p1446731415522">Used vCPU quota</p>
</td>
</tr>
<tr id="topic_300000018__row346791435214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="topic_300000018__p3467914105210">ram</p>
</td>
<td class="cellrowborder" valign="top" width="33.900000000000006%" headers="mcps1.3.4.6.2.4.1.2 "><p id="topic_300000018__p1546751419528">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.1%" headers="mcps1.3.4.6.2.4.1.3 "><p id="topic_300000018__p5467131495210">Used RAM quota</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="topic_300000018__section161364139523"><h4 class="sectiontitle">Example Requests</h4><ul id="topic_300000018__ul125831223152420"><li id="topic_300000018__li11594112392418">URI example<pre class="screen" id="topic_300000018__screen13599162311248">GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/enterprise-projects/quotas?enterprise_project_name=test&amp;offset=1&amp;limit=10</pre>
</li></ul>
</div>
<div class="section" id="topic_300000018__section143171414145211"><h4 class="sectiontitle">Example Responses</h4><p id="topic_300000018__p17469414135215"><strong id="topic_300000018__b8313175382917">Status code: 200</strong></p>
<p id="topic_300000018__p4469181410521">Success.</p>
<pre class="screen" id="topic_300000018__screen1046941445211">{
"quotas" : [ {
"enterprise_project_id" : "c0348bb1-d09d-4ee2-8edd-53e496fe6b52",
"enterprise_project_name" : "test1",
"quota" : {
"instance" : 500,
"vcpus" : 1000,
"ram" : 2000
},
"used" : {
"instance" : 15,
"vcpus" : 88,
"ram" : 256
}
}, {
"enterprise_project_id" : "780a6b1f-58b8-4df6-a85e-326d052de704",
"enterprise_project_name" : "test2",
"quota" : {
"instance" : 500,
"vcpus" : 1000,
"ram" : 2000
},
"used" : {
"instance" : 36,
"vcpus" : 64,
"ram" : 192
}
} ],
"total_count" : 2
}</pre>
</div>
<div class="section" id="topic_300000018__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="topic_300000018__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="topic_300000018__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="topic_300000018__en-us_topic_0000001354223196_p1265915205719">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_300000017.html">Enterprise Projects</a></div>
</div>
</div>