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>
125 lines
8.5 KiB
HTML
125 lines
8.5 KiB
HTML
<a name="evs_04_2075"></a><a name="evs_04_2075"></a>
|
|
|
|
<h1 class="topictitle1">Querying Metadata of an EVS Disk</h1>
|
|
<div id="body38732217"><div class="section" id="evs_04_2075__section19390540"><h4 class="sectiontitle">Function</h4><p id="evs_04_2075__p50301879">This API is used to query the metadata of an EVS disk.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_2075__section40297137"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2075__ul47920438"><li id="evs_04_2075__li28630766">URI format<p id="evs_04_2075__p37390672"><a name="evs_04_2075__li28630766"></a><a name="li28630766"></a>GET /v2/{project_id}/volumes/{volume_id}/metadata</p>
|
|
</li><li id="evs_04_2075__li971734">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2075__table8745607" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2075__row15985080"><th align="left" class="cellrowborder" valign="top" width="24.68%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2075__p19723089">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.310000000000002%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2075__p54066375">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.01%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2075__p17300225">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2075__row59140967"><td class="cellrowborder" valign="top" width="24.68%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2075__p25689059">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2075__p439002">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.01%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2075__p35559222">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2075__row51597550"><td class="cellrowborder" valign="top" width="24.68%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2075__p18651996">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2075__p34416674">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.01%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2075__p36287209">Specifies the disk ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2075__section27129916"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2075__ul11152033120"><li id="evs_04_2075__li1815190173113">Example request<pre class="screen" id="evs_04_2075__screen1411685103115">GET https://{endpoint}/v2/{project_id}/volumes/{volume_id}/metadata</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2075__section42842654"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2075__ul45240216"><li id="evs_04_2075__li8787321201856">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2075__table11977025201856" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2075__row8102228201856"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2075__p52300707201856">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2075__p3642697315541">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2075__p17319263201856">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2075__row60683035201856"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2075__p16378828201856">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2075__p6490369115541">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2075__p20205612201856">Specifies the disk metadata, which is made up of key-value pairs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2075__row108939111229"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2075__p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2075__p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2075__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2075__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2075__li0419202382514"><a name="evs_04_2075__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2075__evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2075__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2075__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2075__evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2075__evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2075__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2075__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2075__evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2075__evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2075__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2075__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2075__evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2075__evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2075__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_2075__evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2075__li4508766">Example response<pre class="screen" id="evs_04_2075__screen5460877810533">{
|
|
"metadata": {
|
|
"key1": "value1",
|
|
"key2": "value2"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2075__p57539933">or</p>
|
|
<pre class="screen" id="evs_04_2075__screen6238602010538">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2075__p47489758202021">In the preceding example, <strong id="evs_04_2075__evs_04_2070_b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2075__evs_04_2070_b842352706144438">badrequest</strong> or <strong id="evs_04_2075__evs_04_2070_b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_2075__screen5868199202121">{
|
|
"badrequest": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2075__section50039568"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2075__ul5136981"><li id="evs_04_2075__li46232835">Normal<p id="evs_04_2075__p13442339"><a name="evs_04_2075__li46232835"></a><a name="li46232835"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2075__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2075__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_4005.html">Disk Metadata Management</a></div>
|
|
</div>
|
|
</div>
|
|
|