vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ims/api-ref/en-us_topic_0093967372.html
Zaoxu, Li c236478734 IMS API DOC 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-05 07:22:50 +00:00

182 lines
14 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0093967372"></a><a name="EN-US_TOPIC_0093967372"></a>
<h1 class="topictitle1">Querying the Image Quota</h1>
<div id="body1516603214809"><div class="section" id="EN-US_TOPIC_0093967372__section4688667014416"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0093967372__p2662397314479">This extension API is used to query the quota of private images of a tenant in the current region.</p>
</div>
<div class="section" id="EN-US_TOPIC_0093967372__section58030181144720"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0093967372__p32815802144733">GET /v1/cloudimages/quota</p>
</div>
<div class="section" id="EN-US_TOPIC_0093967372__section16881426144740"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0093967372__p14587184616402">Request parameters</p>
<p id="EN-US_TOPIC_0093967372__p1428812543476">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0093967372__section75224015469"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0093967372__p127971233113917">Querying the image quota</p>
<pre class="screen" id="EN-US_TOPIC_0093967372__screen984393144612">GET https://{Endpoint}/v1/cloudimages/quota</pre>
</div>
<div class="section" id="EN-US_TOPIC_0093967372__section28921683144828"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0093967372__ul28287440144847"><li id="EN-US_TOPIC_0093967372__li33192113144847">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0093967372__table30935819144853" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0093967372__row17974559144853"><th align="left" class="cellrowborder" valign="top" width="30.486951304869514%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0093967372__p46653204144853">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.078292170782923%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0093967372__p8147776144853">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.434756524347556%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0093967372__p55990086144853">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0093967372__row38903117144853"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0093967372__p64144764144853">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="17.078292170782923%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0093967372__p14115701144853">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0093967372__p2521102144853">Specifies the quota information.</p>
<p id="EN-US_TOPIC_0093967372__p15441192583115">For details, see <a href="#EN-US_TOPIC_0093967372__table147763014020">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0093967372__table147763014020"></a><a name="table147763014020"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0093967372__table147763014020" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure description of the quotas field</caption><thead align="left"><tr id="EN-US_TOPIC_0093967372__row17776405010"><th align="left" class="cellrowborder" valign="top" width="26.097390260973903%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0093967372__p57772001105">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.467853214678534%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0093967372__p1477730605">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.434756524347556%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0093967372__p15777801503">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0093967372__row157772001800"><td class="cellrowborder" valign="top" width="26.097390260973903%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0093967372__p167776019017">resources</p>
</td>
<td class="cellrowborder" valign="top" width="21.467853214678534%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0093967372__p27772001005">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0093967372__p1577710017013">Specifies the images included in the quota.</p>
<p id="EN-US_TOPIC_0093967372__p1710610712410">For details, see <a href="#EN-US_TOPIC_0093967372__table29581211801">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0093967372__table29581211801"></a><a name="table29581211801"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0093967372__table29581211801" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure description of the quotas.resources field</caption><thead align="left"><tr id="EN-US_TOPIC_0093967372__row1895813111011"><th align="left" class="cellrowborder" valign="top" width="25.987401259874016%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0093967372__p109581111016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.57784221577842%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0093967372__p4958121607">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.434756524347556%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0093967372__p11959017013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0093967372__row995951409"><td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0093967372__p119591518018">type</p>
</td>
<td class="cellrowborder" valign="top" width="21.57784221577842%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0093967372__p9959216015">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0093967372__p129597116019">Specifies the type of the resource to be queried.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row295919112011"><td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0093967372__p3959181809">used</p>
</td>
<td class="cellrowborder" valign="top" width="21.57784221577842%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0093967372__p10959211404">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0093967372__p189594110013">Specifies the used quota.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row795911301"><td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0093967372__p1795915119015">quota</p>
</td>
<td class="cellrowborder" valign="top" width="21.57784221577842%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0093967372__p129591818011">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0093967372__p295918110014">Specifies the total quota.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row5959311709"><td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0093967372__p895931304">min</p>
</td>
<td class="cellrowborder" valign="top" width="21.57784221577842%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0093967372__p1095911116012">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0093967372__p139592110017">Specifies the minimum quota.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row18959111307"><td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0093967372__p2959151404">max</p>
</td>
<td class="cellrowborder" valign="top" width="21.57784221577842%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0093967372__p12959411603">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0093967372__p995941803">Specifies the maximum quota.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0093967372__li9489837144915">Example response<pre class="codeblock" id="EN-US_TOPIC_0093967372__codeblock6641838292551">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0093967372__screen9613255145028"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;quotas&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;resources&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;image&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;used&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;quota&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;min&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;max&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1000</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0093967372__section40084941"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0093967372__ul4445458"><li id="EN-US_TOPIC_0093967372__li40009126">Normal<p id="EN-US_TOPIC_0093967372__p24537816"><a name="EN-US_TOPIC_0093967372__li40009126"></a><a name="li40009126"></a>200</p>
</li><li id="EN-US_TOPIC_0093967372__li19513753">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0093967372__table56259839144728" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0093967372__row64271486144728"><th align="left" class="cellrowborder" valign="top" width="46.54%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0093967372__p38607917144728">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.459999999999994%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0093967372__p40233605144728">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0093967372__row37696557144728"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0093967372__p33522253144728">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0093967372__p30947982144728">Request error. For details, see <a href="en-us_topic_0022473689.html">Error Codes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row23758615144728"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0093967372__p45399697144728">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0093967372__p53496868144728">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row11709766144728"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0093967372__p8966960144728">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0093967372__p55235142144728">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row27354238144728"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0093967372__p1100802144728">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0093967372__p22056167144728">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row64287781144728"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0093967372__p39927806144728">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0093967372__p12926859144728">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0093967372__row49232873144728"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0093967372__p28439776144728">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0093967372__p21920511144728">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0093967371.html">Image Quota</a></div>
</div>
</div>
View Git Blame Copy Permalink