forked from laiweijian4/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>
289 lines
21 KiB
HTML
289 lines
21 KiB
HTML
<a name="evs_04_2095"></a><a name="evs_04_2095"></a>
|
|
|
|
<h1 class="topictitle1">Updating an EVS Snapshot</h1>
|
|
<div id="body1493902424385"><div class="section" id="evs_04_2095__section4805694511340"><h4 class="sectiontitle">Function</h4><p id="evs_04_2095__p29847411340">This API is used to update an EVS snapshot.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_2095__section268627411340"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2095__ul1626162711340"><li id="evs_04_2095__li1213691911340">URI format<p id="evs_04_2095__p12724042162534"><a name="evs_04_2095__li1213691911340"></a><a name="li1213691911340"></a>PUT /v2/{project_id}/snapshots/{snapshot_id}</p>
|
|
</li><li id="evs_04_2095__li4356636211340">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2095__table5655293911340" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2095__row4718979611340"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2095__p6427715211340">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2095__p3906685711340">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2095__p1029885411340">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2095__row2890086411340"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2095__p5926863811340">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2095__p3603037711340">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2095__p3277940011340">The project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row2657914711340"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2095__p542726811340">snapshot_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2095__p3695552511340">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2095__p4060754311340">The snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2095__section87667311340"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2095__ul12414559161616"><li id="evs_04_2095__li12415205913164">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2095__table741545961616" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2095__row8415125912161"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="evs_04_2095__p15415175914166">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="evs_04_2095__p16415155919169">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="evs_04_2095__p1741511599167">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="evs_04_2095__p7415059161614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2095__row3416259191613"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="evs_04_2095__p16416195961611">snapshot</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="evs_04_2095__p94161059141619">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="evs_04_2095__p841615914166">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="evs_04_2095__p15416155911161">The information of the snapshot to be updated. For details, see <a href="#evs_04_2095__li143506387236">Parameters in the snapshot field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2095__ul1435010386235"><li id="evs_04_2095__li143506387236"><a name="evs_04_2095__li143506387236"></a><a name="li143506387236"></a>Parameters in the <strong id="evs_04_2095__b76362262247">snapshot</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2095__table16590896104128" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2095__row60389002104128"><th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.3.3.1.2.1.5.1.1"><p id="evs_04_2095__p59671014104128">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.59%" id="mcps1.3.3.3.1.2.1.5.1.2"><p id="evs_04_2095__p1513999104128">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.580000000000002%" id="mcps1.3.3.3.1.2.1.5.1.3"><p id="evs_04_2095__p55525100104128">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.220000000000006%" id="mcps1.3.3.3.1.2.1.5.1.4"><p id="evs_04_2095__p1239270104128">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2095__row33272036104128"><td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2095__p43959720162736">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.59%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2095__p3967568162736">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.580000000000002%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2095__p52937605162736">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.220000000000006%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2095__p60087598162736">The snapshot name, which can contain a maximum of 255 bytes.</p>
|
|
<div class="note" id="evs_04_2095__note154651827114612"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2095__evs_04_2093_p46767097103214">When a disk backup is created, a snapshot will also be created and named with the <strong id="evs_04_2095__b142268571513">autobk_snapshot_</strong> prefix. Operations cannot be performed on such snapshots. Therefore, you are advised not to use <strong id="evs_04_2095__b1465511102218">autobk_snapshot_</strong> as the prefix of snapshot names to avoid any inconvenience.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row12756475104128"><td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2095__p48879957162736">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.59%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2095__p66962416162736">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.580000000000002%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2095__p55246620162736">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.220000000000006%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2095__p45791232162736">The snapshot description, which can contain a maximum of 255 bytes.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2095__ul59359299163411"><li id="evs_04_2095__li64471647163411">Example request<pre class="screen" id="evs_04_2095__screen16645129164253">{
|
|
"snapshot": {
|
|
"name": "snap-001",
|
|
"description": "Daily backup"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2095__section5147449911340"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2095__ul272185315817"><li id="evs_04_2095__li07255317811">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2095__table5724531817" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2095__row473553186"><th align="left" class="cellrowborder" valign="top" width="23.377662233776622%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2095__p1373105313817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.377662233776622%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2095__p11731053784">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.24467553244675%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2095__p4736536811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2095__row197316531287"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2095__p18731553886">snapshot</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2095__p14731953385">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2095__p3731053387">The snapshot information. For details, see <a href="#evs_04_2095__li8366143102514">Parameters in the snapshot field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row9804140716"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2095__p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2095__p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2095__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2095__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2095__ul17429154505120"><li id="evs_04_2095__li8366143102514"><a name="evs_04_2095__li8366143102514"></a><a name="li8366143102514"></a>Parameters in the <strong id="evs_04_2095__b18395758112417">snapshot</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2095__table251963102518" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2095__row18517183132513"><th align="left" class="cellrowborder" valign="top" width="23.377662233776622%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="evs_04_2095__p17515931252">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.377662233776622%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="evs_04_2095__p7515173192517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.24467553244675%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="evs_04_2095__p05179317252">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2095__row351716312517"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p8517838253">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p125173352512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p1251783102517">The snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row451813317253"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1451818312254">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p115184372510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p151812362515">The snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row16518132257"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1051853182512">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p205185362515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p1651863172513">The snapshot name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row5518163152514"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1751813313259">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p155189382519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p165181362512">The snapshot description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row5518137256"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p125182382518">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p951813311252">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p115181317254">The time when the snapshot was created.</p>
|
|
<p id="evs_04_2095__p10500514493">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row10519133253"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1951843112514">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p13519163112515">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p251915313258">The snapshot metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row165197362511"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1451913102511">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p1351963112514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p551913316258">The ID of the snapshot's source disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row10519163192515"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1351923142514">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p65190317252">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p1451963122512">The snapshot size, in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row25191735255"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p1951903192520">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p165198313255">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p95191639256">The time when the snapshot was updated.</p>
|
|
<p id="evs_04_2095__p972113371011">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row1321816580503"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p15317165074710">os-extended-snapshot-attributes:progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p15317250194711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p5317450104716">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__row17836716516"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2095__p112862534489">os-extended-snapshot-attributes:project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2095__p628635317485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2095__p182441155174712">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2095__li0419202382514"><a name="evs_04_2095__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2095__b15700193172218">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2095__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2095__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.3.2.2.1.4.1.1"><p id="evs_04_2095__evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.3.2.2.1.4.1.2"><p id="evs_04_2095__evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.3.2.2.1.4.1.3"><p id="evs_04_2095__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2095__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.2.2.1.4.1.1 "><p id="evs_04_2095__evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.2.2.1.4.1.2 "><p id="evs_04_2095__evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.2.2.1.4.1.3 "><p id="evs_04_2095__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2095__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.2.2.1.4.1.1 "><p id="evs_04_2095__evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.2.2.1.4.1.2 "><p id="evs_04_2095__evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.2.2.1.4.1.3 "><p id="evs_04_2095__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_2095__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></ul>
|
|
<ul id="evs_04_2095__ul36257715104128"><li id="evs_04_2095__li57883987104128">Example response<pre class="screen" id="evs_04_2095__screen40348141164323">{
|
|
"snapshot": {
|
|
"status": "available",
|
|
"description": "Daily backup",
|
|
"created_at": "2013-02-25T03:56:53.081642",
|
|
"metadata": { },
|
|
"volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
|
|
"size": 1,
|
|
"id": "f9faf7df-fdc1-4093-9ef3-5cba06eef995",
|
|
"name": "snap-001",
|
|
"updated_at": "2013-02-25T03:56:53.081642"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2095__p52821068113531">or</p>
|
|
<pre class="screen" id="evs_04_2095__screen28399884152755">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2095__p5655715720175">In the preceding example, <strong id="evs_04_2095__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2095__b842352706144438">badRequest</strong> or <strong id="evs_04_2095__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_2095__screen62922086152813">{
|
|
"itemNotFound": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2095__section1751558211340"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2095__ul947606911340"><li id="evs_04_2095__li1817575711340">Normal<p id="evs_04_2095__p2936408711340"><a name="evs_04_2095__li1817575711340"></a><a name="li1817575711340"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2095__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2095__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_2092.html">EVS Snapshot</a></div>
|
|
</div>
|
|
</div>
|
|
|