forked from docs/doc-exports
zhangyue
ccbf63b495
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
122 lines
8.3 KiB
HTML
122 lines
8.3 KiB
HTML
<a name="evs_04_3046"></a><a name="evs_04_3046"></a>
|
|
|
|
<h1 class="topictitle1">Querying Summary Information of EVS Disks</h1>
|
|
<div id="body1537534631308"><div class="section" id="evs_04_3046__section13269437577"><h4 class="sectiontitle">Function</h4><p id="evs_04_3046__p1150111434576">This API is used to query the summary information of EVS disks, including the disk quantity, total capacity, and metadata information.</p>
|
|
<div class="note" id="evs_04_3046__note31561728102113"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="evs_04_3046__p136531653131514">The request version must be 3.12 or later.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="evs_04_3046__section433454325717"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3046__ul950394315714"><li id="evs_04_3046__li450364316579">URI format<p id="evs_04_3046__p55032043195718"><a name="evs_04_3046__li450364316579"></a><a name="li450364316579"></a>GET /v3/{project_id}/volumes/summary</p>
|
|
</li><li id="evs_04_3046__li1350354314575">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3046__table16338174335710" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3046__row105031043115715"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_3046__p25035437578">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_3046__p1503643145710">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_3046__p145031543165715">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3046__row1150310436576"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3046__p165045438574">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_3046__p20504843175717">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_3046__p14504104315576">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3046__section13354194317578"><h4 class="sectiontitle">Request</h4><ul id="evs_04_3046__ul14963212101"><li id="evs_04_3046__li12496526109">Example request<pre class="screen" id="evs_04_3046__screen1785121151717">GET https://{endpoint}/v3/{project_id}/volumes/summary</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3046__section93541643195718"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3046__ul979015311479"><li id="evs_04_3046__li9790115311477">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3046__table9790753204717" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3046__row1379065318471"><th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_3046__p67904536478">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.39%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_3046__p11790165394719">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.66%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_3046__p147902053104713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3046__row12790145304717"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3046__p147901753114712">volume-summary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3046__p12790115394719">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3046__p14791153134717">Specifies the summary information of queried disks. For details, see <a href="#evs_04_3046__li10504143155718">Parameters in the volume-summary field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_3046__ul1850464318576"><li id="evs_04_3046__li10504143155718"><a name="evs_04_3046__li10504143155718"></a><a name="li10504143155718"></a>Parameters in the <strong id="evs_04_3046__b17101625115417">volume-summary</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3046__table0358124375716" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3046__row55041443195713"><th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="evs_04_3046__p6504443115718">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.39%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="evs_04_3046__p185041743205719">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.66%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="evs_04_3046__p13504104314576">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3046__row650434385716"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3046__p2504134315574">total_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_3046__p1750413434576">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_3046__p16504124325719">Specifies the total size of disks, in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3046__row950464345712"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3046__p95041543155718">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_3046__p95041643185717">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_3046__p0504184385719">Specifies the total quantity of disks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3046__row250411433578"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3046__p1950417435579">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_3046__p1050513439578">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_3046__p6505114318572">Specifies the disk metadata information. This parameter is supported when the request version is 3.36 or later.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_3046__ul2050513431578"><li id="evs_04_3046__li1150584335720">Example response<pre class="screen" id="evs_04_3046__screen1788404111011">{
|
|
"volume-summary": {
|
|
"total_size": 83,
|
|
"total_count": 8,
|
|
"metadata": {}
|
|
}
|
|
}</pre>
|
|
<div class="p" id="evs_04_3046__p564123518583">or<pre class="screen" id="evs_04_3046__screen237464115584">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="evs_04_3046__p12154556125820">In the preceding example, <strong id="evs_04_3046__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_3046__b842352706144438">badRequest</strong> or <strong id="evs_04_3046__b842352706144454">itemNotFound</strong>. An example is provided as follows:<pre class="screen" id="evs_04_3046__screen173371961593">{
|
|
"badRequest": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3046__section1378194317577"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3046__ul450512435578"><li id="evs_04_3046__li150534315570">Normal<p id="evs_04_3046__p105059430575"><a name="evs_04_3046__li150534315570"></a><a name="li150534315570"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3046__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3046__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_3028.html">EVS Disk</a></div>
|
|
</div>
|
|
</div>
|
|
|