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>
326 lines
24 KiB
HTML
326 lines
24 KiB
HTML
<a name="evs_04_2097"></a><a name="evs_04_2097"></a>
|
||
|
||
<h1 class="topictitle1">Querying Details About EVS Snapshots</h1>
|
||
<div id="body1489026315011"><div class="section" id="evs_04_2097__section63129217111110"><h4 class="sectiontitle">Function</h4><p id="evs_04_2097__p13192985111110">This API is used to query details about the EVS snapshots.</p>
|
||
</div>
|
||
<div class="section" id="evs_04_2097__section21460443111127"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2097__ul60574311111127"><li id="evs_04_2097__li8297887111127">URI format<p id="evs_04_2097__p7572119111127"><a name="evs_04_2097__li8297887111127"></a><a name="li8297887111127"></a>GET /v2/{project_id}/snapshots/detail</p>
|
||
</li><li id="evs_04_2097__li1040208111127">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2097__table9361875111127" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2097__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_2097__p1481016775815">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_2097__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_2097__p29982470111127">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2097__row12660986111127"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2097__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_2097__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_2097__p31246529111127">The project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_2097__li14168299016">Request filter parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2097__table49657902111140" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2097__row47265217111140"><th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2097__p3277402111140">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2097__p64143015111140">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.9%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2097__p28201745111140">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="49.78%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2097__p2639999111140">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2097__row15925102920245"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__evs_04_2068_p49168107152914">marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__evs_04_2068_p23193765152914">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__evs_04_2068_p66755704152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__evs_04_2068_p38502923152914">The ID of the resource from which pagination query starts. It is the ID of the last resource on the previous page.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row23759995111140"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__p45511467111140">offset</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__p62550228111140">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__p33403677111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__p21343278111140">The query offset.</p>
|
||
<div class="note" id="evs_04_2097__note6490498915441"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2097__p4727398915441">This parameter is used when snapshots are queried by page and is used together with the <strong id="evs_04_2097__b842352706185037">limit</strong> parameter. For example, there are a total of 30 snapshots. If you set <strong id="evs_04_2097__b84235270618483">offset</strong> to <strong id="evs_04_2097__b84235270618488">11</strong> and <strong id="evs_04_2097__b842352706184813">limit</strong> to <strong id="evs_04_2097__b842352706184818">10</strong>, the query starts from the twelfth snapshot, and a maximum of 10 snapshots can be queried at a time.</p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row57871777111140"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__p57102386111140">limit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__p61890592111140">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__p47082066111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__p55551025111140">The maximum number of query results that can be returned.</p>
|
||
<p id="evs_04_2097__p8961131111161">The value ranges from <strong id="evs_04_2097__b97898204258">1</strong> to <strong id="evs_04_2097__b1279162022517">1000</strong>, and the default value is <strong id="evs_04_2097__b1079212204259">1000</strong>. The returned value cannot exceed this limit.</p>
|
||
<p id="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_2097__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
|
||
<p id="evs_04_2097__p1233994321914"><strong id="evs_04_2097__b1616195497104021">GET /v2/</strong><em id="evs_04_2097__i198955286104021">xxx</em><strong id="evs_04_2097__b1630661680104021">/snapshots/detail?limit=50</strong>: Queries the 1–50 snapshots. <strong id="evs_04_2097__b842352706104032">GET /v2/</strong><em id="evs_04_2097__i1290684130104029">xxx</em><strong id="evs_04_2097__b842352706104037">/snapshots/detail?offset=50&limit=50</strong>: Queries the 51–100 snapshots.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row30197180111140"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__p30052553111140">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__p18337718111140">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__p8960171111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__p54685265111140">The snapshot name, which can contain a maximum of 255 bytes.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row22405342111140"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__p2893391111140">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__p33038150111140">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__p58844456111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__p16372113593415">The snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row15044830111140"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__p10671727111140">volume_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__p59103560111140">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__p22659090111140">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__p23447029111140">The ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row4444568183734"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2097__p826021183742">availability_zone</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2097__p66907753183742">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.9%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2097__p50818876183742">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="49.78%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2097__p22688329183742">The AZ where the snapshot's source disk belongs.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2097__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_2097__p8131165310442">The following example shows how to query details of the snapshots in the <strong id="evs_04_2097__b143525447266">available</strong> state.</p>
|
||
<ul id="evs_04_2097__ul28722627"><li id="evs_04_2097__li57177053">Example request<pre class="screen" id="evs_04_2097__screen13806089161140">GET https://{endpoint}/v2/{project_id}/snapshots/detail?status=available</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2097__section3672851111434"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2097__ul1216711421714"><li id="evs_04_2097__li41681742511">Response parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2097__table1216812421519" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2097__row191683423115"><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_2097__p816844211113">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_2097__p316813421914">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_2097__p71681426114">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2097__row19169242411"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2097__p91690422118">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_2097__p816964217110">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_2097__p19169114217115">The snapshot information. For details, see <a href="#evs_04_2097__li60262741111434">Parameters in the snapshots field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__row5430105519414"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2097__p41699425112">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_2097__p1116954219116">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_2097__p171691426114">The query position marker in the snapshot list. This parameter is returned only when parameter <strong id="evs_04_2097__b14778121519282">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_2097__row2016914421012"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2097__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_2097__evs_04_2010_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_2097__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2097__li0419202382514">Parameters in the error field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="evs_04_2097__ul29065481111434"><li id="evs_04_2097__li60262741111434"><a name="evs_04_2097__li60262741111434"></a><a name="li60262741111434"></a>Parameters in the <strong id="evs_04_2097__b9635204912276">snapshots</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2097__table5493760111434" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2097__p22098020111434">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="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_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_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_2097__p11580698111434">The snapshot ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p53733716111434">The snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p46466595111434">The snapshot name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p55561368111434">The snapshot description.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p49277837111434">The time when the snapshot was created.</p>
|
||
<p id="evs_04_2097__p122996220414">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p778860311364">The time when the snapshot was updated.</p>
|
||
<p id="evs_04_2097__p932912241842">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p34744289111434">The snapshot metadata.</p>
|
||
<p id="evs_04_2097__p1961415054619">If <strong id="evs_04_2097__b842352706193018">metadata</strong> contains the <strong id="evs_04_2097__b842352706193021">__system__enableActive</strong> field, the snapshot is automatically created during the backup of a server.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p41227967111434">The ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p60586455111434">The snapshot size, in GB.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p11980193111434">The tenant ID, which is the same as the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2097__p6625696111434">The reserved field.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="evs_04_2097__ul66919404111434"><li id="evs_04_2097__li0419202382514"><a name="evs_04_2097__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2097__b86812367322">error</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2097__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2097__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_2097__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_2097__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_2097__evs_04_2013_p38578950103019">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2097__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_2097__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_2097__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_2097__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2097__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_2097__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_2097__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_2097__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
||
<p id="evs_04_2097__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_2097__li65403724111434">Example response<pre class="screen" id="evs_04_2097__screen39228533164513">{
|
||
"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
|
||
},
|
||
{
|
||
"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
|
||
}
|
||
]
|
||
}</pre>
|
||
<p id="evs_04_2097__p52821068113531">or</p>
|
||
<pre class="screen" id="evs_04_2097__screen27832886153037">{
|
||
"error": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
<p id="evs_04_2097__p5655715720175">In the preceding example, <strong id="evs_04_2097__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2097__b842352706144438">badRequest</strong> or <strong id="evs_04_2097__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
||
<pre class="screen" id="evs_04_2097__screen26319244153056">{
|
||
"itemNotFound": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2097__section7038241111643"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2097__ul33226654111643"><li id="evs_04_2097__li30604436111643">Normal<p id="evs_04_2097__p7004472111643"><a name="evs_04_2097__li30604436111643"></a><a name="li30604436111643"></a>200</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2097__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2097__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2092.html">EVS Snapshot</a></div>
|
||
</div>
|
||
</div>
|
||
|