forked from docs/doc-exports
lizaoxu
ecf810a948
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: lizaoxu <lizaoxu@huawei.com> Co-committed-by: lizaoxu <lizaoxu@huawei.com>
314 lines
25 KiB
HTML
314 lines
25 KiB
HTML
<a name="evs_04_2016"></a><a name="evs_04_2016"></a>
|
|
|
|
<h1 class="topictitle1">Creating an EVS Snapshot</h1>
|
|
<div id="body1543222941129"><div class="section" id="evs_04_2016__section29798282112049"><h4 class="sectiontitle">Function</h4><p id="evs_04_2016__p1384316781514">This API is used to create an EVS snapshot. <span id="evs_04_2016__text1239383487113735"></span></p>
|
|
</div>
|
|
<div class="section" id="evs_04_2016__section56404342112049"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2016__ul5348971112049"><li id="evs_04_2016__li48140745112049">URI format<p id="evs_04_2016__p4482031234"><a name="evs_04_2016__li48140745112049"></a><a name="li48140745112049"></a>POST /v2/{project_id}/cloudsnapshots</p>
|
|
</li></ul>
|
|
<ul id="evs_04_2016__ul7086238112049"><li id="evs_04_2016__li63776143112049">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2016__evs_04_3056_table28484833104128" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2016__evs_04_3056_row60547305104128"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.2.3.1.1.1.4.1.1"><p id="evs_04_2016__evs_04_3056_p5384679104128">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.2.3.1.1.1.4.1.2"><p id="evs_04_2016__evs_04_3056_p33505894104128">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.2.3.1.1.1.4.1.3"><p id="evs_04_2016__evs_04_3056_p29622926104128">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2016__evs_04_3056_row50646790104128"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.3.1.1.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p8749302104128">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.3.1.1.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p37604871104128">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.2.3.1.1.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p26095712104128">The project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2016__section54272198112126"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2016__evs_04_3056_ul9723142491119"><li id="evs_04_2016__evs_04_3056_li1672412249111">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2016__evs_04_3056_table1572462410119" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2016__evs_04_3056_row2724724141119"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="evs_04_2016__evs_04_3056_p20724132431116">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_2016__evs_04_3056_p3724122431120">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="evs_04_2016__evs_04_3056_p15724192491114">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="evs_04_2016__evs_04_3056_p0724324121113">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2016__evs_04_3056_row147241024121113"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="evs_04_2016__evs_04_3056_p187251024171111">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_2016__evs_04_3056_p67255248118">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="evs_04_2016__evs_04_3056_p127251724191119">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="evs_04_2016__evs_04_3056_p16725122411114">The information of the snapshot to be created. For details, see <a href="#evs_04_2016__evs_04_3056_li39126135104128">Parameters in the snapshot field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2016__evs_04_3056_ul19260429104128"><li id="evs_04_2016__evs_04_3056_li39126135104128"><a name="evs_04_2016__evs_04_3056_li39126135104128"></a><a name="evs_04_3056_li39126135104128"></a>Parameters in the <strong id="evs_04_2016__evs_04_3056_b1241711282210">snapshot</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2016__evs_04_3056_table16590896104128" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2016__evs_04_3056_row60389002104128"><th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.3.3.1.2.1.5.1.1"><p id="evs_04_2016__evs_04_3056_p59671014104128">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.3.3.1.2.1.5.1.2"><p id="evs_04_2016__evs_04_3056_p1513999104128">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.34%" id="mcps1.3.3.3.1.2.1.5.1.3"><p id="evs_04_2016__evs_04_3056_p55525100104128">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.339999999999996%" id="mcps1.3.3.3.1.2.1.5.1.4"><p id="evs_04_2016__evs_04_3056_p1239270104128">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2016__evs_04_3056_row12756475104128"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2016__evs_04_3056_p26641549104128">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2016__evs_04_3056_p10481847104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2016__evs_04_3056_p43723298104128">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2016__evs_04_3056_p51926262104128">The ID of the snapshot's source disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row64683174104128"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2016__evs_04_3056_p4845737104128">force</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2016__evs_04_3056_p56960425104128">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2016__evs_04_3056_p50391693104128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2016__evs_04_3056_p32530251113919">The flag for forcibly creating a snapshot. The default value is <strong id="evs_04_2016__evs_04_3056_b842352706181613">false</strong>.</p>
|
|
<ul id="evs_04_2016__evs_04_3056_ul60750582141455"><li id="evs_04_2016__evs_04_3056_li4878587141455">If this parameter is set to <strong id="evs_04_2016__evs_04_3056_b1283675572152242">false</strong> and the disk is in the <strong id="evs_04_2016__evs_04_3056_b842352706181628">attaching</strong> state, the snapshot cannot be forcibly created.</li><li id="evs_04_2016__evs_04_3056_li5444646714152">If this parameter is set to <strong id="evs_04_2016__evs_04_3056_b174167542715230">true</strong> and the disk is in the <strong id="evs_04_2016__evs_04_3056_b2069781284">attaching</strong> state, the snapshot can be forcibly created.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row26995886104128"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2016__evs_04_3056_p39183164104128">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2016__evs_04_3056_p19719755104128">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2016__evs_04_3056_p53796355104128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2016__evs_04_3056_p62537483104128">The snapshot metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row25966436104128"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2016__evs_04_3056_p22906600104128">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2016__evs_04_3056_p43495312104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2016__evs_04_3056_p33459397104128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2016__evs_04_3056_p25856622104128">The snapshot description. The value can be <strong id="evs_04_2016__evs_04_3056_b84235270618184">null</strong>. <span id="evs_04_2016__evs_04_3056_text503174715201714">The value can contain a maximum of 255 bytes.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row31383010104128"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2016__evs_04_3056_p58995861104128">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2016__evs_04_3056_p13935408104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2016__evs_04_3056_p55026268104128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2016__evs_04_3056_p27942720104128">The snapshot name. <span id="evs_04_2016__evs_04_3056_text1418954783201721">The value can contain a maximum of 255 bytes.</span></p>
|
|
<div class="note" id="evs_04_2016__evs_04_3056_note12652884103214"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2016__evs_04_3056_p46767097103214">When creating a backup for a disk, a snapshot will be created and named with prefix <strong id="evs_04_2016__evs_04_3056_b84235270616432">autobk_snapshot_</strong>. The EVS console has imposed operation restrictions on snapshots with prefix <strong id="evs_04_2016__evs_04_3056_b842352706164512">autobk_snapshot_</strong>. Therefore, you are advised not to use <strong id="evs_04_2016__evs_04_3056_b842352706164552">autobk_snapshot_</strong> as the name prefix for the snapshots you created. Otherwise, the snapshots cannot be used normally.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2016__evs_04_3056_ul36257715104128"><li id="evs_04_2016__evs_04_3056_li57883987104128">Example request<pre class="screen" id="evs_04_2016__evs_04_3056_screen20956395164139">{
|
|
"snapshot": {
|
|
"name": "snap-001",
|
|
"description": "Daily backup",
|
|
"volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
|
|
"force": false,
|
|
"metadata": { }
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2016__section50618846112239"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2016__evs_04_3056_ul58281147531"><li id="evs_04_2016__evs_04_3056_li4828134711311">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2016__evs_04_3056_table6828747432" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2016__evs_04_3056_row382812473312"><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_2016__evs_04_3056_p198297471937">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_2016__evs_04_3056_p2082911475318">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_2016__evs_04_3056_p182916473314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2016__evs_04_3056_row168291947832"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p982919471312">snapshot</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_2016__evs_04_3056_p08292471734">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_2016__evs_04_3056_p208298477312">The snapshot information. For details, see <a href="#evs_04_2016__evs_04_3056_li52620487104128">Parameters in the snapshot field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row5943559134615"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_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_2016__evs_04_3056_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_2016__evs_04_3056_p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2016__evs_04_3056_li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2016__evs_04_3056_ul28216342104128"><li id="evs_04_2016__evs_04_3056_li52620487104128"><a name="evs_04_2016__evs_04_3056_li52620487104128"></a><a name="evs_04_3056_li52620487104128"></a>Parameters in the <strong id="evs_04_2016__evs_04_3056_b7376107162312">snapshot</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2016__evs_04_3056_table3822335104128" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2016__evs_04_3056_row44730354104128"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="evs_04_2016__evs_04_3056_p66388932104128">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="evs_04_2016__evs_04_3056_p8794435104128">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="evs_04_2016__evs_04_3056_p53776742104128">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2016__evs_04_3056_row41515896104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p7344400104128">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p58025504104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p63859146104128">The snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row37861410104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p46875355104128">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p38807409104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p4381265104128">The snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row39431393104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p39826261104128">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p4701738104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p45139478104128">The snapshot name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row3602118104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p23336160104128">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p11180798104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p7230824104128">The snapshot description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row65077419104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p36779556104128">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p26354021104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p36300897104128">The time when the snapshot was created.</p>
|
|
<p id="evs_04_2016__evs_04_3056_p1277514183418"><span id="evs_04_2016__evs_04_3056_text56625358415">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row58272623104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p22462033104128">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p7485408104128">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p55185187104128">The snapshot metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row26904637104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p31791970104128">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p25012792104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p27759637104128">The ID of the snapshot's source disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row48510149104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p37007959104128">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p44854718104128">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p19441706104128">The snapshot size, in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row40757631104128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p13033849104128">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p49108876104128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p13680922104128">The time when the snapshot was updated.</p>
|
|
<p id="evs_04_2016__evs_04_3056_p24641261550"><span id="evs_04_2016__evs_04_3056_text123011106519">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row123171850104712"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p15317165074710">os-extended-snapshot-attributes:progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p15317250194711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p5317450104716">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_row17244355194710"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_p112862534489">os-extended-snapshot-attributes:project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_p628635317485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_p182441155174712">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2016__evs_04_3056_ul34412902104128"><li id="evs_04_2016__evs_04_3056_li0419202382514"><a name="evs_04_2016__evs_04_3056_li0419202382514"></a><a name="evs_04_3056_li0419202382514"></a>Parameters in the <strong id="evs_04_2016__evs_04_3056_evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2016__evs_04_3056_evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2016__evs_04_3056_evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.4.1.2.1.4.1.1"><p id="evs_04_2016__evs_04_3056_evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.4.1.2.1.4.1.2"><p id="evs_04_2016__evs_04_3056_evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.4.1.2.1.4.1.3"><p id="evs_04_2016__evs_04_3056_evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2016__evs_04_3056_evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.4.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.4.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.4.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2016__evs_04_3056_evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.4.1.2.1.4.1.1 "><p id="evs_04_2016__evs_04_3056_evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.4.1.2.1.4.1.2 "><p id="evs_04_2016__evs_04_3056_evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.4.1.2.1.4.1.3 "><p id="evs_04_2016__evs_04_3056_evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_2016__evs_04_3056_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_2016__evs_04_3056_li41280666104128">Example response<pre class="screen" id="evs_04_2016__evs_04_3056_screen499817416428">{
|
|
"snapshot": {
|
|
"status": "creating",
|
|
"description": "Daily backup",
|
|
"created_at": "2013-02-25T03:56:53.081642",
|
|
"metadata": { },
|
|
"volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
|
|
"size": 1,
|
|
"id": "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
|
|
"name": "snap-001",
|
|
"updated_at": "2013-02-25T03:56:53.081642"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2016__evs_04_3056_p52821068113531">or</p>
|
|
<pre class="screen" id="evs_04_2016__evs_04_3056_screen49985784152557">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2016__evs_04_3056_p5655715720175">In the preceding example, <strong id="evs_04_2016__evs_04_3056_b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2016__evs_04_3056_b842352706144438">badRequest</strong> or <strong id="evs_04_2016__evs_04_3056_b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_2016__evs_04_3056_screen62160680152616">{
|
|
"itemNotFound": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2016__section16529200112352"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2016__en-us_topic_0051408624_ul18564055104128"><li id="evs_04_2016__en-us_topic_0051408624_li32858773104128">Normal<p id="evs_04_2016__en-us_topic_0051408624_p27293504104128"><a name="evs_04_2016__en-us_topic_0051408624_li32858773104128"></a><a name="en-us_topic_0051408624_li32858773104128"></a>202</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2016__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2016__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_2015.html">Snapshot Management</a></div>
|
|
</div>
|
|
</div>
|
|
|