Files
doc-exports/docs/evs/api-ref/evs_04_2019.html
lizaoxu ecf810a948 EVS API Update
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: lizaoxu <lizaoxu@huawei.com>
Co-committed-by: lizaoxu <lizaoxu@huawei.com>
2025-07-08 08:52:45 +00:00

230 lines
19 KiB
HTML

<a name="evs_04_2019"></a><a name="evs_04_2019"></a>
<h1 class="topictitle1">Querying Details About an EVS Snapshot </h1>
<div id="body1543223566274"><div class="section" id="evs_04_2019__section30030484111731"><h4 class="sectiontitle">Function</h4><p id="evs_04_2019__p16550165111731">This API is used to query details about an EVS snapshot. <span id="evs_04_2019__text1496970509114423"></span></p>
</div>
<div class="section" id="evs_04_2019__section14733765111731"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2019__ul52584336111731"><li id="evs_04_2019__li3496981111731">URI format<p id="evs_04_2019__p37131912103213"><a name="evs_04_2019__li3496981111731"></a><a name="li3496981111731"></a>GET /v2/{project_id}/cloudsnapshots/{snapshot_id}</p>
</li><li id="evs_04_2019__li14820068111731">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2019__evs_04_3061_table66271751111731" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2019__evs_04_3061_row56106054111731"><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_2019__evs_04_3061_p48296540111731">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_2019__evs_04_3061_p19705674111731">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_2019__evs_04_3061_p52655801111731">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2019__evs_04_3061_row37261521111731"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p65393209111731">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_2019__evs_04_3061_p62358553111731">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_2019__evs_04_3061_p17878042111731">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row26684654111731"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p13973379111731">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_2019__evs_04_3061_p58101900111731">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_2019__evs_04_3061_p8633458111731">The snapshot ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2019__section28221468111731"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2019__ul11893201815415"><li id="evs_04_2019__li589415182414">Example request<pre class="screen" id="evs_04_2019__screen1567142719413">GET https://{endpoint}/v2/{project_id}/cloudsnapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2019__section63055193111836"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2019__evs_04_3061_ul11297192701313"><li id="evs_04_2019__evs_04_3061_li10298142718137">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2019__evs_04_3061_table12298112761311" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2019__evs_04_3061_row3298122761310"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2019__evs_04_3061_p1129817277138">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2019__evs_04_3061_p102981727131315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2019__evs_04_3061_p1829872710136">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2019__evs_04_3061_row1029817278135"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p72986273130">snapshot</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p3299527151313">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p102991727171313">The snapshot information. For details, see <a href="#evs_04_2019__evs_04_3061_li64773086111836">Parameters in the snapshot field</a>.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row1148619118454"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2019__evs_04_3061_li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2019__evs_04_3061_ul7197009111836"><li id="evs_04_2019__evs_04_3061_li64773086111836"><a name="evs_04_2019__evs_04_3061_li64773086111836"></a><a name="evs_04_3061_li64773086111836"></a>Parameters in the <strong id="evs_04_2019__evs_04_3061_b117887477255">snapshot</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2019__evs_04_3061_table46086870111836" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2019__evs_04_3061_row56202297111836"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="evs_04_2019__evs_04_3061_p56092213111836">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="evs_04_2019__evs_04_3061_p47175401111836">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="evs_04_2019__evs_04_3061_p11730844111836">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2019__evs_04_3061_row15559516111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p52361272111836">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p13404600111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p34969797111836">The snapshot ID.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row46292725111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p58723264111836">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p58963956111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p47023540111836">The snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row20558679111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p54640283111836">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p63786796111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p14293074111836">The snapshot name.</p>
<p id="evs_04_2019__evs_04_3061_p1338613133449">Snapshots whose names started with prefix <strong id="evs_04_2019__evs_04_3061_b8266932154912">autobk_snapshot_</strong> are automatically created by the system during backup creations. Do not delete these snapshots or use them to roll back the disk data.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row61528809111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p17777665111836">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p30704745111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p60132426111836">The snapshot description.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row4320926111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p14450739111836">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p29659196111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p45391308111836">The time when the snapshot was created.</p>
<p id="evs_04_2019__evs_04_3061_p1559945216131"><span id="evs_04_2019__evs_04_3061_text462016291416">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row3737236411149"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p80695711149">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p6536351711149">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p2439511411149">The time when the snapshot was updated.</p>
<p id="evs_04_2019__evs_04_3061_p4282185140"><span id="evs_04_2019__evs_04_3061_text106095811141">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row5868590111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p5593786111836">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p50443518111836">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p46118865111836">The snapshot metadata.</p>
<p id="evs_04_2019__evs_04_3061_p771812911458">If <strong id="evs_04_2019__evs_04_3061_b842352706193018">metadata</strong> contains the <strong id="evs_04_2019__evs_04_3061_b842352706193021">__system__enableActive</strong> field, the snapshot is automatically created during the backup of a server.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row12416602111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p66220711111836">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p62277393111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p43213914111836">The ID of the snapshot's source disk.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row53380907111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p28886228111836">size</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p58083101111836">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p39095984111836">The snapshot size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row16319538111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p46814240111836">os-extended-snapshot-attributes:project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p33857106111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_p6137764111836">The tenant ID. <span id="evs_04_2019__evs_04_3061_text19941457165313">The tenant ID is the same as the project ID.</span></p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_row55239881111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2019__evs_04_3061_p45245366111836">os-extended-snapshot-attributes:progress</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2019__evs_04_3061_p40996011111836">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2019__evs_04_3061_en-us_topic_0123550104_p170219911618"><span id="evs_04_2019__evs_04_3061_text4730642777">The reserved field.</span></p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2019__evs_04_3061_ul507655111913"><li id="evs_04_2019__evs_04_3061_li0419202382514"><a name="evs_04_2019__evs_04_3061_li0419202382514"></a><a name="evs_04_3061_li0419202382514"></a>Parameters in the <strong id="evs_04_2019__evs_04_3061_evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2019__evs_04_3061_evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2019__evs_04_3061_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_2019__evs_04_3061_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_2019__evs_04_3061_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_2019__evs_04_3061_evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2019__evs_04_3061_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_2019__evs_04_3061_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_2019__evs_04_3061_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_2019__evs_04_3061_evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2019__evs_04_3061_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_2019__evs_04_3061_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_2019__evs_04_3061_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_2019__evs_04_3061_evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2019__evs_04_3061_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_2019__evs_04_3061_li4568903111913">Example response<pre class="screen" id="evs_04_2019__evs_04_3061_screen20703801105829">{
"snapshot": {
"status": "available",
"os-extended-snapshot-attributes:progress": "100%",
"description": "daily backup",
"created_at": "2013-02-25t04:13:17.000000",
"metadata": {},
"volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
"os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
"size": 1,
"id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
"name": "snap-001",
"updated_at": null
}
}</pre>
<p id="evs_04_2019__evs_04_3061_p52821068113531">or</p>
<pre class="screen" id="evs_04_2019__evs_04_3061_screen30304462153128">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2019__evs_04_3061_p5655715720175">In the preceding example, <strong id="evs_04_2019__evs_04_3061_b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2019__evs_04_3061_b842352706144438">badRequest</strong> or <strong id="evs_04_2019__evs_04_3061_b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2019__evs_04_3061_screen21709082153146">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2019__section38811440112026"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2019__evs_04_3061_ul56718896112026"><li id="evs_04_2019__evs_04_3061_li40708017112026">Normal<p id="evs_04_2019__evs_04_3061_p30827836112026"><a name="evs_04_2019__evs_04_3061_li40708017112026"></a><a name="evs_04_3061_li40708017112026"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2019__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2019__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>