vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vbs/api-ref/en-us_topic_0113236392.html
Wei, Hongmin 63123ef1be VBS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-25 07:47:39 +00:00

242 lines
18 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0113236392"></a><a name="EN-US_TOPIC_0113236392"></a>
<h1 class="topictitle1">Querying Quotas</h1>
<div id="body1526870440550"><div class="section" id="EN-US_TOPIC_0113236392__section950113935210"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0113236392__p10546171018525">This API is used to query tenant quotas.</p>
</div>
<div class="section" id="EN-US_TOPIC_0113236392__section250516965217"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0113236392__ul18548710145211"><li id="EN-US_TOPIC_0113236392__li2054813109524">URI<p id="EN-US_TOPIC_0113236392__p1548010185215"><a name="EN-US_TOPIC_0113236392__li2054813109524"></a><a name="li2054813109524"></a>GET /v2/{project_id}/cloudbackups/quota</p>
</li><li id="EN-US_TOPIC_0113236392__li4548310165213">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0113236392__table1652713917528" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0113236392__row1754891035211"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="EN-US_TOPIC_0113236392__p954819105529">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="EN-US_TOPIC_0113236392__p85481510115216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="EN-US_TOPIC_0113236392__p1254891014523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0113236392__row9548141085212"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0113236392__p554811014523">tenant _id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="EN-US_TOPIC_0113236392__p125483102528">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="EN-US_TOPIC_0113236392__p64170449">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0113236392__section55671592524"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0113236392__ul1854812108525"><li id="EN-US_TOPIC_0113236392__li654881015525">Parameter description</li></ul>
<p id="EN-US_TOPIC_0113236392__p7548161015217">None</p>
<ul id="EN-US_TOPIC_0113236392__ul1548111018520"><li id="EN-US_TOPIC_0113236392__li3548121035212">Example request</li></ul>
<pre class="screen" id="EN-US_TOPIC_0113236392__screen9548111025210"> GET /v2/{project_id}/cloudbackups/quota</pre>
</div>
<div class="section" id="EN-US_TOPIC_0113236392__section1458819165212"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0113236392__ul145482106526"><li id="EN-US_TOPIC_0113236392__li12548410135219">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0113236392__table17618797528" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0113236392__row55481610115213"><th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0113236392__p5548201065217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0113236392__p354891017521">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0113236392__p05486107523">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0113236392__p9548121018525">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0113236392__row1954801011528"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0113236392__p554818102529">quotas</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0113236392__p105484104527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0113236392__p552115123177">map&lt;string, string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0113236392__p145214123173">Quota resource information</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0113236392__ul1454817104523"><li id="EN-US_TOPIC_0113236392__li6548111095211">Parameter description of field <strong id="EN-US_TOPIC_0113236392__b15654360">quota</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0113236392__table1964912912529" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0113236392__row10548910135218"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="EN-US_TOPIC_0113236392__p20548110135215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="EN-US_TOPIC_0113236392__p35481210185216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="EN-US_TOPIC_0113236392__p1754818102525">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="EN-US_TOPIC_0113236392__p125481110145220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0113236392__row195481210205219"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0113236392__p18548141017527">resources</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0113236392__p12548191085215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0113236392__p15548141065214">List&lt;resource_resp&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0113236392__p1554891020527">Quota resources</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0113236392__ul1654891005215"><li id="EN-US_TOPIC_0113236392__li55489106523">Parameter description of field <strong id="EN-US_TOPIC_0113236392__b16941207">resource_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0113236392__table1767914985211" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0113236392__row175491410105212"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.4.1.2.1.5.1.1"><p id="EN-US_TOPIC_0113236392__p854931011526">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.4.1.2.1.5.1.2"><p id="EN-US_TOPIC_0113236392__p155491410155216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.4.1.2.1.5.1.3"><p id="EN-US_TOPIC_0113236392__p3550171095219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.4.1.2.1.5.1.4"><p id="EN-US_TOPIC_0113236392__p75501810145218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0113236392__row1555181010521"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.4.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0113236392__p45511510145211">reserved</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0113236392__p1655120104526">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0113236392__p1955151020528">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0113236392__p115521910145214">Reserved amount</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row13552210125214"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.4.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0113236392__p2055341055213">used</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0113236392__p1755314109522">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0113236392__p8553101019523">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0113236392__p2553141011521">Used amount</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row1855381065217"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.4.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0113236392__p9554410115214">quota</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0113236392__p19554510175218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0113236392__p755414102520">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0113236392__p20554410185213">Quota size. <strong id="EN-US_TOPIC_0113236392__b842352706161346">-1</strong> indicates no restriction on the quota size.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row0555121018529"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.4.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0113236392__p8555101011521">type</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0113236392__p1155531016521">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0113236392__p955512104528">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0113236392__p18555161095211">Type</p>
<p id="EN-US_TOPIC_0113236392__p2555510175219">Enum:[ backup_gigabytes ,backups]</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0113236392__ul145552010195218"><li id="EN-US_TOPIC_0113236392__li455571018528">Example response<pre class="screen" id="EN-US_TOPIC_0113236392__screen65551310175210">{
"quotas": {
"resources":[{
"type" :"backups",
"used" : 114,
"reserved" : 0,
"quota" : 5014
},
{
"type": "backup_ gigabytes",
"used" : 4838,
"reserved" : 0,
"quota" : -1
}]
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0113236392__section157825916529"><h4 class="sectiontitle">Return Values</h4><ul id="EN-US_TOPIC_0113236392__ul355716106525"><li id="EN-US_TOPIC_0113236392__li1955731095214">Normal</li></ul>
<p id="EN-US_TOPIC_0113236392__p1440334351814">200</p>
<ul id="EN-US_TOPIC_0113236392__ul12559410115211"><li id="EN-US_TOPIC_0113236392__li85595100529">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0113236392__table788082612015" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0113236392__row9159427142015"><th align="left" class="cellrowborder" valign="top" width="43.43%" id="mcps1.3.5.4.1.1.1.3.1.1"><p id="EN-US_TOPIC_0113236392__p61601627152017">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.5.4.1.1.1.3.1.2"><p id="EN-US_TOPIC_0113236392__p816018272206">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0113236392__row12160142714208"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p9160182710202">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p1116019275206">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row716012715207"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p201601627172019">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p101601627142012">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row1216082772016"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p141609270203">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p4160172712010">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row1316012742013"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p131609273200">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p1116042714208">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row116022732014"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p17161162714207">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p61613272207">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row14161127162010"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p1716116276200">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p13161182732018">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row81621427102016"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p51621127112012">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p16162192711200">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row15163152762013"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p7163102782013">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p1716362752017">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row11639277209"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p151631027162015">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p151641727112011">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row9164132752017"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p111641527132013">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p9164122710202">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row1164927112013"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p13164152792019">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p1316512702017">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row616552716207"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p13165202782019">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p8166527162012">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row1416692712201"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p216716272202">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p116710273201">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0113236392__row26101580103927"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.4.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0113236392__p44055172103930">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0113236392__p11699152103930">A gateway timeout error occurred.</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_0020237254.html">VBS Backups</a></div>
</div>
</div>
View Git Blame Copy Permalink