vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/gaussdb_mysql/api-ref/ShowGaussMySqlProjectQuotas.html
Hasko, Vladimir c1056e5100 Recreating PR 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-07-11 13:57:29 +00:00

246 lines
19 KiB
HTML
Raw Permalink Blame History

<a name="ShowGaussMySqlProjectQuotas"></a><a name="ShowGaussMySqlProjectQuotas"></a>
<h1 class="topictitle1">Querying the DB Instance Quotas of a Tenant</h1>
<div id="body0000001163001447"><div class="section" id="ShowGaussMySqlProjectQuotas__section19786106173713"><h4 class="sectiontitle">Function</h4><p id="ShowGaussMySqlProjectQuotas__p52780252141331">This API is used to obtain the resource quotas of a specified tenant. Before using this API:</p>
<ul id="ShowGaussMySqlProjectQuotas__ul924420236520"><li id="ShowGaussMySqlProjectQuotas__gaussdb_04_0011_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ShowGaussMySqlProjectQuotas__gaussdb_04_0011_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section8283100184718"><h4 class="sectiontitle">URI</h4><p id="ShowGaussMySqlProjectQuotas__p162832094712">GET /v3/{project_id}/project-quotas</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__table028416018473" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row162841309474"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowGaussMySqlProjectQuotas__p1428411015473">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowGaussMySqlProjectQuotas__p1128420084720">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowGaussMySqlProjectQuotas__p42841013477">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowGaussMySqlProjectQuotas__p1928415074712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row5284110144714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowGaussMySqlProjectQuotas__p1928410054718">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowGaussMySqlProjectQuotas__p62851802475">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowGaussMySqlProjectQuotas__p12851707479">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowGaussMySqlProjectQuotas__p2904438105416">Project ID of a tenant in a region.</p>
<p id="ShowGaussMySqlProjectQuotas__p15904113811547">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__table12854017479" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row152852001472"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ShowGaussMySqlProjectQuotas__p13285180124715">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ShowGaussMySqlProjectQuotas__p1285170154711">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ShowGaussMySqlProjectQuotas__p128617018477">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ShowGaussMySqlProjectQuotas__p328640114713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row12285130114719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowGaussMySqlProjectQuotas__p1128610134717">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowGaussMySqlProjectQuotas__p1128617011473">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowGaussMySqlProjectQuotas__p16286190194716">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowGaussMySqlProjectQuotas__p172865015479">Resource type used to filter quotas. Its value can be <strong id="ShowGaussMySqlProjectQuotas__b196125835324035">instance</strong>.</p>
<p id="ShowGaussMySqlProjectQuotas__p7286120124713">Valid value:</p>
<ul id="ShowGaussMySqlProjectQuotas__ul1628610134716"><li id="ShowGaussMySqlProjectQuotas__li42865014714"><strong id="ShowGaussMySqlProjectQuotas__b152860017472">instance</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section528612019473"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row182871044715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowGaussMySqlProjectQuotas__p7287170154720">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowGaussMySqlProjectQuotas__p102871706478">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowGaussMySqlProjectQuotas__p42871308473">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowGaussMySqlProjectQuotas__p3287170134710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row172874064714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowGaussMySqlProjectQuotas__p1528714015477">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowGaussMySqlProjectQuotas__p92871094719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowGaussMySqlProjectQuotas__p182886084719">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowGaussMySqlProjectQuotas__p428814014718">User token.</p>
</td>
</tr>
<tr id="ShowGaussMySqlProjectQuotas__row62872013470"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowGaussMySqlProjectQuotas__p42883015476">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowGaussMySqlProjectQuotas__p82888011470">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowGaussMySqlProjectQuotas__p11288150184711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowGaussMySqlProjectQuotas__p028814018470">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section72884094714"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowGaussMySqlProjectQuotas__p12885016475"><strong id="ShowGaussMySqlProjectQuotas__b86830424525051">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__response_ShowProjectQuotasResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row142889044712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowGaussMySqlProjectQuotas__p62890004718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowGaussMySqlProjectQuotas__p0289708478">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowGaussMySqlProjectQuotas__p1289190144716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row328814084713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p11289702470">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p162897024714"><a href="#ShowGaussMySqlProjectQuotas__response_project-quotas">project-quotas</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p1628916014714">Tenant instance quota information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowGaussMySqlProjectQuotas__response_project-quotas"></a><a name="response_project-quotas"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__response_project-quotas" frame="border" border="1" rules="all"><caption><b>Table 5 </b>project-quotas</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row3290001479"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowGaussMySqlProjectQuotas__p15291110164717">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowGaussMySqlProjectQuotas__p02914054717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowGaussMySqlProjectQuotas__p15291120114713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row162908034718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p82918024710">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p14291160164717">Array of <a href="#ShowGaussMySqlProjectQuotas__response_resource">resource</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p529114004711">Resource list objects.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowGaussMySqlProjectQuotas__response_resource"></a><a name="response_resource"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__response_resource" frame="border" border="1" rules="all"><caption><b>Table 6 </b>resource</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row82919014473"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowGaussMySqlProjectQuotas__p1029212074710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowGaussMySqlProjectQuotas__p329212018476">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowGaussMySqlProjectQuotas__p12927044718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row1929120034710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p172924015471">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p1129210174717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p11292006476">Quota of a specified type.</p>
<ul id="ShowGaussMySqlProjectQuotas__ul0292709472"><li id="ShowGaussMySqlProjectQuotas__li14292507478"><strong id="ShowGaussMySqlProjectQuotas__b19563250165711">instance</strong>: indicates the DB instance quota.</li></ul>
<p id="ShowGaussMySqlProjectQuotas__p4292150104717">Valid value:</p>
<ul id="ShowGaussMySqlProjectQuotas__ul1829200104716"><li id="ShowGaussMySqlProjectQuotas__li162931505473"><strong id="ShowGaussMySqlProjectQuotas__b529370204710">instance</strong></li></ul>
</td>
</tr>
<tr id="ShowGaussMySqlProjectQuotas__row129117064714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p82931405471">used</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p1629380144719">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p929315016475">Number of created resources.</p>
</td>
</tr>
<tr id="ShowGaussMySqlProjectQuotas__row029112015476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p1929310174711">quota</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p329314004714">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p6293100184717">Maximum resource quota.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowGaussMySqlProjectQuotas__p829314074713"><strong id="ShowGaussMySqlProjectQuotas__b135010821525243">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row10294180194715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowGaussMySqlProjectQuotas__p129400124719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowGaussMySqlProjectQuotas__p13294170104719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowGaussMySqlProjectQuotas__p829490104713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row182941403478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p1829440124718">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p14294903471">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p16295906475">Error code.</p>
</td>
</tr>
<tr id="ShowGaussMySqlProjectQuotas__row7294140184712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p1829550104712">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p62951607476">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p7295110114716">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowGaussMySqlProjectQuotas__p7295160124717"><strong id="ShowGaussMySqlProjectQuotas__b16652859165516">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlProjectQuotas__table82951803477" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowGaussMySqlProjectQuotas__row229514018478"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="ShowGaussMySqlProjectQuotas__p929650104719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="ShowGaussMySqlProjectQuotas__p172961606477">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="ShowGaussMySqlProjectQuotas__p112961904472">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowGaussMySqlProjectQuotas__row329515012477"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p22968024714">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p1529620164717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p2296907470">Error code.</p>
</td>
</tr>
<tr id="ShowGaussMySqlProjectQuotas__row72952034712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowGaussMySqlProjectQuotas__p52962019471">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowGaussMySqlProjectQuotas__p1229630164715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowGaussMySqlProjectQuotas__p5296701472">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section629710014718"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="ShowGaussMySqlProjectQuotas__screen12931131082111">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance</pre>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section529718024713"><h4 class="sectiontitle">Example Response</h4><p id="ShowGaussMySqlProjectQuotas__p162972012476"><strong id="ShowGaussMySqlProjectQuotas__b208811606225051">Status code: 200</strong></p>
<p id="ShowGaussMySqlProjectQuotas__p1929714012477">Success.</p>
<pre class="screen" id="ShowGaussMySqlProjectQuotas__screen1029716018475">{
"quotas" : {
"resources" : [ {
"type" : "instance,",
"used" : "4,",
"quota" : 50
} ]
}
}</pre>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section586556143713"><h4 class="sectiontitle">Status Code</h4><p id="ShowGaussMySqlProjectQuotas__en-us_topic_0241383157_p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="ShowGaussMySqlProjectQuotas__section14870136103715"><h4 class="sectiontitle">Error Code</h4><p id="ShowGaussMySqlProjectQuotas__p55531081373">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0010.html">Quota Management</a></div>
</div>
</div>
View Git Blame Copy Permalink