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>
344 lines
27 KiB
HTML
344 lines
27 KiB
HTML
<a name="evs_04_3060"></a><a name="evs_04_3060"></a>
|
||
|
||
<h1 class="topictitle1">Querying Details About EVS Snapshots</h1>
|
||
<div id="body1521539800062"><div class="section" id="evs_04_3060__section63129217111110"><h4 class="sectiontitle">Function</h4><p id="evs_04_3060__p13192985111110">This API is used to query details about the EVS snapshots.</p>
|
||
</div>
|
||
<div class="section" id="evs_04_3060__section21460443111127"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3060__ul60574311111127"><li id="evs_04_3060__li8297887111127">URI format<p id="evs_04_3060__p176771272571"><a name="evs_04_3060__li8297887111127"></a><a name="li8297887111127"></a>GET /v3/{project_id}/snapshots/detail</p>
|
||
</li><li id="evs_04_3060__li1040208111127">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3060__table9361875111127" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3060__row34794340111127"><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_3060__p66878179111127">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_3060__p48423414111127">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_3060__p147761015152112">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3060__row12660986111127"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3060__p18906939111127">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_3060__p55067056111127">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_3060__p31246529111127">Specifies the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3060__li16117185515179">Request filter parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3060__evs_04_2097_table49657902111140" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3060__evs_04_2097_row47265217111140"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_3060__evs_04_2097_p3277402111140">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_3060__evs_04_2097_p64143015111140">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_3060__evs_04_2097_p28201745111140">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_3060__evs_04_2097_p2639999111140">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3060__row19129165444110"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__evs_04_2068_p49168107152914">marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__evs_04_2068_p23193765152914">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__evs_04_2068_p66755704152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3060__evs_04_2068_p38502923152914"><span id="evs_04_3060__text127381323152311">The ID of the resource from which the pagination query starts. It is the ID of the last resource on the previous page.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row23759995111140"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__evs_04_2097_p45511467111140">offset</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__evs_04_2097_p62550228111140">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__evs_04_2097_p33403677111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3060__evs_04_2097_p21343278111140">Specifies the offset.</p>
|
||
<div class="note" id="evs_04_3060__evs_04_2097_note6490498915441"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3060__evs_04_2097_p4727398915441">This parameter is used when snapshots are queried by page and is used together with the <strong id="evs_04_3060__b842352706185037">limit</strong> parameter. For example, there are a total of 30 snapshots. If you set <strong id="evs_04_3060__b84235270618483">offset</strong> to <strong id="evs_04_3060__b84235270618488">11</strong> and <strong id="evs_04_3060__b842352706184813">limit</strong> to <strong id="evs_04_3060__b842352706184818">10</strong>, the queried snapshot starts from the twelfth snapshot, and at most 10 snapshots can be queried at a time.</p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row57871777111140"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__evs_04_2097_p57102386111140">limit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__evs_04_2097_p61890592111140">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__evs_04_2097_p47082066111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3060__evs_04_2097_p55551025111140">Specifies the maximum number of query results that can be returned.</p>
|
||
<p id="evs_04_3060__p12396191941414"><span id="evs_04_3060__text138349551887">The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.</span></p>
|
||
<p id="evs_04_3060__evs_04_2097_p14657115572511">If the tenant has more than 50 snapshots in total, you are advised to use this parameter and set its value to <strong id="evs_04_3060__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
|
||
<p id="evs_04_3060__evs_04_2097_p1233994321914"><strong id="evs_04_3060__b1616195497104021">GET /v3/</strong><em id="evs_04_3060__i198955286104021">xxx</em><strong id="evs_04_3060__b1630661680104021">/snapshots/detail?limit=50</strong>: Queries the 1–50 snapshots. <strong id="evs_04_3060__b842352706104032">GET /v3/</strong><em id="evs_04_3060__i1290684130104029">xxx</em><strong id="evs_04_3060__b842352706104037">/snapshots/detail?offset=50&limit=50</strong>: Queries the 51–100 snapshots.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row30197180111140"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__evs_04_2097_p30052553111140">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__evs_04_2097_p18337718111140">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__evs_04_2097_p8960171111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3060__evs_04_2097_p54685265111140">Specifies the snapshot name. The value can contain a maximum of 255 bytes.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__row475111724717"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__p463319195457">sort_dir</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__p1163321984520">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__p663321934517">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><div class="p" id="evs_04_3060__p2030231013183">Specifies the result sorting order. The default value is <strong id="evs_04_3060__b82711154299">desc</strong>.<ul id="evs_04_3060__ul66131813171815"><li id="evs_04_3060__li861361361817"><strong id="evs_04_3060__b163431692919">desc</strong>: indicates the descending order.</li><li id="evs_04_3060__li8614191351816"><strong id="evs_04_3060__b13867141642912">asc</strong>: indicates the ascending order.</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row22405342111140"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__evs_04_2097_p2893391111140">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__evs_04_2097_p33038150111140">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__evs_04_2097_p58844456111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3060__evs_04_2097_p1671647111140">Specifies the snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row15044830111140"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3060__evs_04_2097_p10671727111140">volume_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3060__evs_04_2097_p59103560111140">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3060__evs_04_2097_p22659090111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3060__evs_04_2097_p23447029111140">Specifies the ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3060__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_3060__p8131165310442">The following example shows how to query details of the snapshots in the <strong id="evs_04_3060__b268081919305">available</strong> state.</p>
|
||
<ul id="evs_04_3060__ul28722627"><li id="evs_04_3060__li57177053">Example request<pre class="screen" id="evs_04_3060__screen13806089161140">GET https://{endpoint}/v3/{project_id}/snapshots/detail?status=available</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3060__section3672851111434"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3060__ul131081449171916"><li id="evs_04_3060__li7108154921911">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3060__table410874917199" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3060__row191081949171912"><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_3060__p910894918193">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_3060__p10108124917198">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_3060__p21092049111914">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3060__row210984917198"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3060__p1110918496191">snapshots</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_3060__p71092049171917">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_3060__p1510954919191">Specifies the snapshot information. For details, see <a href="#evs_04_3060__evs_04_2097_li60262741111434">Parameters in the snapshots field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__row423792912203"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3060__p13109154941914">snapshots_links</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_3060__p19109154931910">list<map<String,String>></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_3060__p9109649111919">Specifies the query position marker in the snapshot list. This parameter is at the same level as parameter <strong id="evs_04_3060__b8408616173112">snapshots</strong> in the response body. This parameter is returned only when parameter <strong id="evs_04_3060__b12408131613313">limit</strong> is specified in the request, and this parameter indicates that only some snapshots are returned in this query.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__row41117491194"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3060__p611224941917">count</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_3060__p1911211493192">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_3060__p6112184910193">Specifies the number of records returned in this query.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__row203891619182012"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3060__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_3060__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_3060__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_3060__li0419202382514">Parameters in the error field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="evs_04_3060__evs_04_2097_ul29065481111434"><li id="evs_04_3060__evs_04_2097_li60262741111434"><a name="evs_04_3060__evs_04_2097_li60262741111434"></a><a name="evs_04_2097_li60262741111434"></a>Parameters in the <strong id="evs_04_3060__b11441748143117">snapshots</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3060__evs_04_2097_table5493760111434" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3060__evs_04_2097_row9951929111434"><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_3060__evs_04_2097_p799881111434">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_3060__evs_04_2097_p64790373111434">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_3060__evs_04_2097_p22098020111434">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3060__evs_04_2097_row30338895111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p41531445111434">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_3060__evs_04_2097_p8603891111434">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_3060__evs_04_2097_p11580698111434">Specifies the snapshot ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row37117420111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p53721059111434">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_3060__evs_04_2097_p56438551111434">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_3060__evs_04_2097_p53733716111434">Specifies the snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row13841398111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p47411481111434">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_3060__evs_04_2097_p15124732111434">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_3060__evs_04_2097_p46466595111434">Specifies the snapshot name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row15546175111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p51280630111434">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_3060__evs_04_2097_p60090386111434">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_3060__evs_04_2097_p55561368111434">Specifies the snapshot description.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row30290270111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p37592805111434">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_3060__evs_04_2097_p25118356111434">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_3060__evs_04_2097_p49277837111434">Specifies the time when the snapshot was created.</p>
|
||
<p id="evs_04_3060__p191521633192117"><span id="evs_04_3060__text152359383212">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row62090946113559"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p4553543411364">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_3060__evs_04_2097_p6449156711364">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_3060__evs_04_2097_p778860311364">Specifies the time when the snapshot was updated.</p>
|
||
<p id="evs_04_3060__p17722194212116"><span id="evs_04_3060__text1096915422211">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row40847350111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p20301014111434">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_3060__evs_04_2097_p33769410111434">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_3060__evs_04_2097_p34744289111434">Specifies the snapshot metadata.</p>
|
||
<p id="evs_04_3060__p1678772717473">If <strong id="evs_04_3060__b842352706193018">metadata</strong> contains the <strong id="evs_04_3060__b842352706193021">__system__enableActive</strong> field, the snapshot is automatically created during the backup of a server.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row44263150111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p28545410111434">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_3060__evs_04_2097_p30476837111434">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_3060__evs_04_2097_p41227967111434">Specifies the ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row35507385111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p57525930111434">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_3060__evs_04_2097_p29088719111434">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_3060__evs_04_2097_p60586455111434">Specifies the snapshot size, in GB.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row8407183111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p9893207111434">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_3060__evs_04_2097_p63152279111434">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_3060__evs_04_2097_p11980193111434">Specifies the tenant ID. <span id="evs_04_3060__text19941457165313">The tenant ID is the same as the project ID.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__evs_04_2097_row40712881111434"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__evs_04_2097_p9409050111434">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_3060__evs_04_2097_p23935584111434">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_3060__evs_04_2097_p6625696111434"><span id="evs_04_3060__text4730642777">The reserved field.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__row11295723102014"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_3060__p95423280203">user_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_3060__p1354218288209">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_3060__p845483673211">Reserved field</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="evs_04_3060__evs_04_2097_ul66919404111434"><li id="evs_04_3060__li0419202382514"><a name="evs_04_3060__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_3060__evs_04_2013_b1288034833610">error</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3060__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3060__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_3060__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_3060__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_3060__evs_04_2013_p38578950103019">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3060__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_3060__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_3060__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_3060__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3060__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_3060__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_3060__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_3060__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
||
<p id="evs_04_3060__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_3060__evs_04_2097_li65403724111434">Example response<pre class="screen" id="evs_04_3060__screen3109415142212">{
|
||
|
||
"snapshots": [
|
||
{
|
||
"status": "available",
|
||
"os-extended-snapshot-attributes:progress": "100%",
|
||
"description": null,
|
||
"created_at": "2013-06-19T07:15:29.000000",
|
||
"metadata": { },
|
||
"volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
|
||
"os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
|
||
"size": 5,
|
||
"id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
|
||
"name": "name_xx2-snap",
|
||
"updated_at": null,
|
||
"user_id": "48d70679b8644035846b2cb53633c256"
|
||
},
|
||
{
|
||
"status": "available",
|
||
"os-extended-snapshot-attributes:progress": "100%",
|
||
"description": null,
|
||
"created_at": "2013-06-19T09:08:08.000000",
|
||
"metadata": { },
|
||
"volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
|
||
"os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
|
||
"size": 5,
|
||
"id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
|
||
"name": "name_xx2-snap",
|
||
"updated_at": null,
|
||
"user_id": "48d70679b8644035846b2cb53633c256"
|
||
}
|
||
]
|
||
}</pre>
|
||
<p id="evs_04_3060__evs_04_2097_p52821068113531">or</p>
|
||
<pre class="screen" id="evs_04_3060__evs_04_2097_screen27832886153037">{
|
||
"error": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
<p id="evs_04_3060__evs_04_2097_p5655715720175">In the preceding example, <strong id="evs_04_3060__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_3060__b842352706144438">badRequest</strong> or <strong id="evs_04_3060__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
||
<pre class="screen" id="evs_04_3060__evs_04_2097_screen26319244153056">{
|
||
"itemNotFound": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3060__section7038241111643"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3060__evs_04_2097_ul33226654111643"><li id="evs_04_3060__evs_04_2097_li30604436111643">Normal<p id="evs_04_3060__evs_04_2097_p7004472111643"><a name="evs_04_3060__evs_04_2097_li30604436111643"></a><a name="evs_04_2097_li30604436111643"></a>200</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3060__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3060__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>
|
||
|