forked from docs/doc-exports
zhangyue
f3b09e5d2f
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
181 lines
13 KiB
HTML
181 lines
13 KiB
HTML
<a name="evs_04_3042"></a><a name="evs_04_3042"></a>
|
|
|
|
<h1 class="topictitle1">Updating One Piece of Metadata for an EVS Disk</h1>
|
|
<div id="body1521535091031"><div class="section" id="evs_04_3042__section19390540"><h4 class="sectiontitle">Function</h4><p id="evs_04_3042__p50301879">This API is used to update one piece of the EVS disk metadata.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_3042__section40297137"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3042__ul47920438"><li id="evs_04_3042__li28630766">URI format<p id="evs_04_3042__p4081867221314"><a name="evs_04_3042__li28630766"></a><a name="li28630766"></a>PUT /v3/{project_id}/volumes/{volume_id}/metadata/{key}</p>
|
|
</li><li id="evs_04_3042__li971734">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3042__table8745607" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3042__row15985080"><th align="left" class="cellrowborder" valign="top" width="27.88%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_3042__p19723089">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.11%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_3042__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_3042__p17300225">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3042__row59140967"><td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3042__p25689059">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_3042__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_3042__p35559222">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3042__row51597550"><td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3042__p18651996">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_3042__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_3042__p36287209">Specifies the disk ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3042__row3599748213115"><td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3042__p23144139213115">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_3042__p62735991213115">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_3042__p48450544213115">Specifies the key of the piece of metadata to be updated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3042__section27129916"><h4 class="sectiontitle">Request</h4><ul id="evs_04_3042__evs_04_2078_ul772326021175"><li id="evs_04_3042__evs_04_2078_li240048321175">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3042__evs_04_2078_table31588048" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3042__evs_04_2078_row57330849"><th align="left" class="cellrowborder" valign="top" width="17.49%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="evs_04_3042__evs_04_2078_p13287175">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.22%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="evs_04_3042__evs_04_2078_p2519427">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.240000000000002%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="evs_04_3042__evs_04_2078_p2747002">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.05%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="evs_04_3042__evs_04_2078_p21180630">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3042__evs_04_2078_row53167494153413"><td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="evs_04_3042__evs_04_2078_p11599783153413">meta</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="evs_04_3042__evs_04_2078_p58405153413">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.240000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="evs_04_3042__evs_04_2078_p4730855153413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.05%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="evs_04_3042__evs_04_2078_p47654998153413">Specifies the disk metadata to be updated. For details, see <a href="#evs_04_3042__evs_04_2078_li54973602211845">Parameter in the meta field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3042__evs_04_2078_li54973602211845"><a name="evs_04_3042__evs_04_2078_li54973602211845"></a><a name="evs_04_2078_li54973602211845"></a>Parameter in the <strong id="evs_04_3042__evs_04_2078_b51921872817">meta</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3042__evs_04_2078_table32717123212358" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3042__evs_04_2078_row2280240212358"><th align="left" class="cellrowborder" valign="top" width="17.49%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="evs_04_3042__evs_04_2078_p50481723212358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.22%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="evs_04_3042__evs_04_2078_p62487767212358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.990000000000002%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="evs_04_3042__evs_04_2078_p28344363212358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.3%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="evs_04_3042__evs_04_2078_p14192096212358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3042__evs_04_2078_row8709150212358"><td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3042__evs_04_2078_p34352524212358">key_val</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3042__evs_04_2078_p31091026212358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3042__evs_04_2078_p35345177212358">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3042__evs_04_2078_p44387080212358">Specifies a piece of metadata, which is made up of a key-value pair.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3042__evs_04_2078_li47272903212140">Example request<pre class="screen" id="evs_04_3042__evs_04_2078_screen60685247162719">{
|
|
"meta": {
|
|
"key1": "value1"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3042__section42842654"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3042__evs_04_2078_ul45240216"><li id="evs_04_3042__evs_04_2078_li8787321201856">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3042__evs_04_2078_table11977025201856" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3042__evs_04_2078_row8102228201856"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_3042__evs_04_2078_p52300707201856">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_3042__evs_04_2078_p3642697315541">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_3042__evs_04_2078_p17319263201856">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3042__evs_04_2078_row60683035201856"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3042__evs_04_2078_p16378828201856">meta</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3042__evs_04_2078_p6490369115541">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3042__evs_04_2078_p20205612201856">Specifies a piece of the disk metadata, which is made up of a key-value pair.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3042__evs_04_2078_row9713816171"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3042__evs_04_2078_p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3042__evs_04_2078_p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3042__evs_04_2078_p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_3042__evs_04_2078_li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3042__evs_04_2078_li0419202382514"><a name="evs_04_3042__evs_04_2078_li0419202382514"></a><a name="evs_04_2078_li0419202382514"></a>Parameters in the <strong id="evs_04_3042__evs_04_2078_evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3042__evs_04_2078_evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3042__evs_04_2078_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_3042__evs_04_2078_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_3042__evs_04_2078_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_3042__evs_04_2078_evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3042__evs_04_2078_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_3042__evs_04_2078_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_3042__evs_04_2078_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_3042__evs_04_2078_evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3042__evs_04_2078_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_3042__evs_04_2078_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_3042__evs_04_2078_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_3042__evs_04_2078_evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_3042__evs_04_2078_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_3042__evs_04_2078_li4508766">Example response<pre class="screen" id="evs_04_3042__evs_04_2078_screen5460877810533">{
|
|
"meta": {
|
|
"key1": "value1"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_3042__evs_04_2078_p8355436185729">or</p>
|
|
<pre class="screen" id="evs_04_3042__evs_04_2078_screen59558308185754">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_3042__evs_04_2078_p5655715720175">In the preceding example, <strong id="evs_04_3042__evs_04_2078_b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_3042__evs_04_2078_b842352706144438">badRequest</strong> or <strong id="evs_04_3042__evs_04_2078_b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_3042__evs_04_2078_screen33288191151334">{
|
|
"badRequest": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3042__section50039568"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3042__evs_04_2078_ul5136981"><li id="evs_04_3042__evs_04_2078_li46232835">Normal<p id="evs_04_3042__evs_04_2078_p13442339"><a name="evs_04_3042__evs_04_2078_li46232835"></a><a name="evs_04_2078_li46232835"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3042__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3042__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>
|
|
|