doc-exports/docs/evs/api-ref/evs_04_3061.html
zhangyue f3b09e5d2f Elastic Volume Service API V1
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-02 16:28:20 +00:00

237 lines
18 KiB
HTML

<a name="evs_04_3061"></a><a name="evs_04_3061"></a>
<h1 class="topictitle1">Querying Details About an EVS Snapshot</h1>
<div id="body1521539980048"><div class="section" id="evs_04_3061__section30030484111731"><h4 class="sectiontitle">Function</h4><p id="evs_04_3061__p16550165111731">This API is used to query details about an EVS snapshot.</p>
</div>
<div class="section" id="evs_04_3061__section14733765111731"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3061__ul52584336111731"><li id="evs_04_3061__li3496981111731">URI format<p id="evs_04_3061__p141651141704"><a name="evs_04_3061__li3496981111731"></a><a name="li3496981111731"></a>GET /v3/{project_id}/snapshots/{snapshot_id}</p>
</li><li id="evs_04_3061__li14820068111731">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3061__table66271751111731" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_3061__p52655801111731">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_3061__p17878042111731">Specifies the project ID.</p>
</td>
</tr>
<tr id="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_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_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_3061__p8633458111731">Specifies the snapshot ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_3061__section28221468111731"><h4 class="sectiontitle">Request</h4><ul id="evs_04_3061__evs_04_2098_ul28722627"><li id="evs_04_3061__evs_04_2098_li57177053">Example request<pre class="screen" id="evs_04_3061__evs_04_2098_screen13806089161140">GET https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995</pre>
</li></ul>
</div>
<div class="section" id="evs_04_3061__section63055193111836"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3061__ul1473015418276"><li id="evs_04_3061__li16730641182716">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3061__table12730134172713" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3061__row473014182718"><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_3061__p7730941122712">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_3061__p7731104122719">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_3061__p4731184118271">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3061__row2073111417271"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3061__p6732134115272">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_3061__p17732141102714">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_3061__p11732194114271">Specifies the snapshot information. For details, see <a href="#evs_04_3061__evs_04_2098_li64773086111836">Parameters in the snapshot field</a>.</p>
</td>
</tr>
<tr id="evs_04_3061__row1273219418275"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="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_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_3061__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_3061__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_3061__evs_04_2098_ul7197009111836"><li id="evs_04_3061__evs_04_2098_li64773086111836"><a name="evs_04_3061__evs_04_2098_li64773086111836"></a><a name="evs_04_2098_li64773086111836"></a>Parameters in the <strong id="evs_04_3061__b1782783293515">snapshot</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3061__evs_04_2098_table46086870111836" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p11730844111836">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3061__evs_04_2098_row15559516111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p34969797111836">Specifies the snapshot ID.</p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row46292725111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p47023540111836">Specifies the snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row20558679111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p14293074111836">Specifies the snapshot name.</p>
<p id="evs_04_3061__p5124959164711">Snapshots whose names started with prefix <strong id="evs_04_3061__b322031418439">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_3061__evs_04_2098_row61528809111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p60132426111836">Specifies the snapshot description.</p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row4320926111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p45391308111836">Specifies the time when the snapshot was created.</p>
<p id="evs_04_3061__p96931622122813"><span id="evs_04_3061__text20291102912819">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row3737236411149"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p2439511411149">Specifies the time when the snapshot was updated.</p>
<p id="evs_04_3061__p1827253412288"><span id="evs_04_3061__text1059311346285">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row5868590111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p46118865111836">Specifies the snapshot metadata.</p>
<p id="evs_04_3061__p1678772717473">If <strong id="evs_04_3061__b842352706193018">metadata</strong> contains the <strong id="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_3061__evs_04_2098_row12416602111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p43213914111836">Specifies the ID of the snapshot's source disk.</p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row53380907111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p39095984111836">Specifies the snapshot size, in GB.</p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row16319538111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p6137764111836">Specifies the tenant ID. <span id="evs_04_3061__text19941457165313">The tenant ID is the same as the project ID.</span></p>
</td>
</tr>
<tr id="evs_04_3061__evs_04_2098_row55239881111836"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__evs_04_2098_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_3061__evs_04_2098_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_3061__evs_04_2098_p18028606145913"><span id="evs_04_3061__text4730642777">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_3061__row1598314715534"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3061__p1316171114535">user_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_3061__p8316101125312">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_3061__p20348100143311">Reserved field</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_3061__evs_04_2098_ul507655111913"><li id="evs_04_3061__li0419202382514"><a name="evs_04_3061__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_3061__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3061__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_3061__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_3061__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="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_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_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_3061__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="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_3061__evs_04_2098_li4568903111913">Example response<pre class="screen" id="evs_04_3061__screen054274375413">{
"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,
"user_id": "48d70679b8644035846b2cb53633c256",
"id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
"name": "snap-001",
"updated_at": null
}
}</pre>
<p id="evs_04_3061__evs_04_2098_p52821068113531">or</p>
<pre class="screen" id="evs_04_3061__evs_04_2098_screen30304462153128">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_3061__evs_04_2098_p5655715720175">In the preceding example, <strong id="evs_04_3061__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_3061__b842352706144438">badRequest</strong> or <strong id="evs_04_3061__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_3061__evs_04_2098_screen21709082153146">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_3061__section38811440112026"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3061__evs_04_2098_ul56718896112026"><li id="evs_04_3061__evs_04_2098_li40708017112026">Normal<p id="evs_04_3061__evs_04_2098_p30827836112026"><a name="evs_04_3061__evs_04_2098_li40708017112026"></a><a name="evs_04_2098_li40708017112026"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_3061__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3061__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_3055.html">EVS Snapshot</a></div>
</div>
</div>