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>
384 lines
31 KiB
HTML
384 lines
31 KiB
HTML
<a name="evs_04_3059"></a><a name="evs_04_3059"></a>
|
||
|
||
<h1 class="topictitle1">Querying EVS Snapshots</h1>
|
||
<div id="body1521539600757"><div class="section" id="evs_04_3059__section5262172611544"><h4 class="sectiontitle">Function</h4><p id="evs_04_3059__p3450141711544">This API is used to query the EVS snapshots.</p>
|
||
</div>
|
||
<div class="section" id="evs_04_3059__section1511931811555"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3059__ul1670526611555"><li id="evs_04_3059__li1612967411555">URI format<p id="evs_04_3059__p12247449175320"><a name="evs_04_3059__li1612967411555"></a><a name="li1612967411555"></a>GET /v3/{project_id}/snapshots</p>
|
||
</li><li id="evs_04_3059__li3143519211555">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3059__table1448127211555" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3059__row3175017111555"><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_3059__p2162703411555">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_3059__p695931811555">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_3059__p2683384611555">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3059__row2605789011555"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3059__p3031437111555">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_3059__p3954502511555">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_3059__p4903046711555">Specifies the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3059__li147901271718">Request filter parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3059__evs_04_2096_table633033061168" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3059__evs_04_2096_row57109071168"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_3059__evs_04_2096_p599303181168">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_3059__evs_04_2096_p225175981168">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_3059__evs_04_2096_p119861301168">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="48.51485148514851%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_3059__evs_04_2096_p313524671168">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3059__row1869818449417"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__evs_04_2068_p49168107152914">marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__evs_04_2068_p23193765152914">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__evs_04_2068_p66755704152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__evs_04_2068_p38502923152914"><span id="evs_04_3059__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_3059__evs_04_2096_row137367471168"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__evs_04_2096_p389347291168">offset</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__evs_04_2096_p667053841168">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__evs_04_2096_p344270561168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__evs_04_2096_p371281361168">Specifies the offset.</p>
|
||
<div class="note" id="evs_04_3059__evs_04_2096_note6490498915441"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3059__evs_04_2096_p4727398915441">This parameter is used when snapshots are queried by page and is used together with the <strong id="evs_04_3059__b842352706185037">limit</strong> parameter. For example, there are a total of 30 snapshots. If you set <strong id="evs_04_3059__b84235270618483">offset</strong> to <strong id="evs_04_3059__b84235270618488">11</strong> and <strong id="evs_04_3059__b842352706184813">limit</strong> to <strong id="evs_04_3059__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_3059__evs_04_2096_row657177691168"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__evs_04_2096_p215391011168">limit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__evs_04_2096_p669456211168">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__evs_04_2096_p538862341168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__evs_04_2096_p27088191168">Specifies the maximum number of query results that can be returned.</p>
|
||
<p id="evs_04_3059__p283195819137"><span id="evs_04_3059__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_3059__evs_04_2096_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_3059__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
|
||
<p id="evs_04_3059__evs_04_2096_p1233994321914"><strong id="evs_04_3059__b1293145333103912">GET /v3/</strong><em id="evs_04_3059__i994780625103912">xxx</em><strong id="evs_04_3059__b1828569207103912">/snapshots?limit=50</strong>: Queries the 1–50 snapshots. <strong id="evs_04_3059__b842352706103924">GET /v3/</strong><em id="evs_04_3059__i1514360640103921">xxx</em><strong id="evs_04_3059__b842352706103930">/snapshots?offset=50&limit=50</strong>: Queries the 51–100 snapshots.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row243793751168"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__evs_04_2096_p285723381168">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__evs_04_2096_p326580131168">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__evs_04_2096_p280534011168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__evs_04_2096_p577330051168">Specifies the snapshot name. This parameter does not support fuzzy search. <span id="evs_04_3059__text700391859194046">The value can contain a maximum of 255 bytes.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row288521214459"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__p463319195457">sort_dir</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__p1163321984520">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__p663321934517">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><div class="p" id="evs_04_3059__p1751520421266">Specifies the result sorting order. The default value is <strong id="evs_04_3059__b729920359318">desc</strong>.<ul id="evs_04_3059__ul1729318471065"><li id="evs_04_3059__li192941747362"><strong id="evs_04_3059__b81691371532">desc</strong>: indicates the descending order.</li><li id="evs_04_3059__li92949471467"><strong id="evs_04_3059__b1311012381339">asc</strong>: indicates the ascending order.</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row498350041168"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__evs_04_2096_p101035441168">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__evs_04_2096_p130807691168">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__evs_04_2096_p529093741168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__evs_04_2096_p578009201168">Specifies the snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row504462351168"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__evs_04_2096_p596132261168">volume_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__evs_04_2096_p639420261168">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__evs_04_2096_p119216351168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__evs_04_2096_p261283481168">Specifies the ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row3561144994516"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__p1355262793315">name~</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__p15552102720334">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__p12552102719334">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__p11552182715331">Specifies the fuzzy search by disk name. This parameter is supported when the request version is 3.31 or later.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row9561144912457"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__p555232714335">status~</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__p11553122753313">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__p1955322717338">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__p25531427163315">Specifies the fuzzy search by disk status. This parameter is supported when the request version is 3.31 or later.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row16561104944515"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__p1268088124912">volume_id~</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__p1668012820493">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__p1968058154912">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__p768018824914">Specifies the fuzzy search by the ID of the disk that corresponds to the snapshot. This parameter is supported when the request version is 3.31 or later.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row1561249144519"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__p668115818494">sort_key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__p176812811492">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__p468111819494">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__p2068120884920">Specifies the sorting query by name (sort_key=name). This parameter is supported when the request version is 3.30 or later. The default sorting order is the descending order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row3563124984516"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3059__p155547276337">with_count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3059__p855442773311">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3059__p1055420271339">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3059__p26217111246">Specifies to return parameter <strong id="evs_04_3059__b842352706111032">counts</strong> in the response. This parameter indicates the number of snapshots queried. This parameter is in the <em id="evs_04_3059__i842352697111123">with_count=true</em> format and is supported when the request version is 3.45 or later.</p>
|
||
<p id="evs_04_3059__p1459918123014">This parameter can be used together with parameters <strong id="evs_04_3059__b157416521153">marker</strong>, <strong id="evs_04_3059__b18742652191519">limit</strong>, <strong id="evs_04_3059__b1874311526150">sort_key</strong>, <strong id="evs_04_3059__b1743175210159">sort_dir</strong>, or <strong id="evs_04_3059__b37443525156">offset</strong> in the table. It cannot be used with other filter parameters.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3059__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_3059__p8131165310442">The following example shows how to query the snapshots in the <strong id="evs_04_3059__b15632946414">available</strong> state.</p>
|
||
<ul id="evs_04_3059__ul28722627"><li id="evs_04_3059__li57177053">Example request<pre class="screen" id="evs_04_3059__screen13806089161140">GET https://{endpoint}/v3/{project_id}/snapshots?status=available</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3059__section539031881175"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3059__evs_04_2096_ul40820781175"><li id="evs_04_3059__li6790443785">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3059__table16791124318811" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3059__row279119431881"><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_3059__p147912431813">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_3059__p6791134320813">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_3059__p147911943187">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3059__row11792943087"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3059__p279264316818">snapshots</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_3059__p1379218434810">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_3059__p879218431681">Specifies the snapshot information. For details, see <a href="#evs_04_3059__evs_04_2096_li367387041175">Parameters in the snapshots field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row19562135513816"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3059__p147911431788">snapshots_links</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_3059__p1279210431813">list<map<String,String>></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_3059__p163671041196">Specifies the query position marker in the snapshot list. This parameter is at the same level as parameter <strong id="evs_04_3059__b18842436161">snapshots</strong> in the response body. This parameter is returned only when parameter <strong id="evs_04_3059__b1484253612619">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_3059__row1579418431988"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3059__p1779412431788">count</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_3059__evs_04_2010_p159017261855">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_3059__p57949436815">Specifies the number of records returned in this query.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__row67494216911"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3059__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_3059__evs_04_2010_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_3059__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_3059__li0419202382514">Parameters in the error field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3059__evs_04_2096_li367387041175"><a name="evs_04_3059__evs_04_2096_li367387041175"></a><a name="evs_04_2096_li367387041175"></a>Parameters in the <strong id="evs_04_3059__b105715573718">snapshots</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3059__evs_04_2096_table622128841175" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3059__evs_04_2096_row535860991175"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_3059__evs_04_2096_p455067371175">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_3059__evs_04_2096_p621670471175">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_3059__evs_04_2096_p574320291175">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3059__evs_04_2096_row505356201175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p668534581175">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p464210281175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p283450141175">Specifies the snapshot ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row537785391175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p610943921175">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p496987011175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p583203691175">Specifies the snapshot status. For details, see <a href="evs_04_0041.html">EVS Snapshot Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row551212811175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p356388081175">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p10622981175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p575287091175">Specifies the snapshot name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row479963371175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p624980901175">description</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p291805641175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p592057221175">Specifies the snapshot description.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row630894511175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p99718891175">created_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p24167171175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p183889601175">Specifies the time when the snapshot was created.</p>
|
||
<p id="evs_04_3059__p181121789819"><span id="evs_04_3059__text1271511210811">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row312829201175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p508885661175">metadata</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p283331481175">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p22339381175">Specifies the snapshot metadata.</p>
|
||
<p id="evs_04_3059__p1678772717473">If <strong id="evs_04_3059__b842352706193018">metadata</strong> contains the <strong id="evs_04_3059__b842352706193021">__system__enableActive</strong> field, the snapshot is automatically created during the backup of a server.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row201054491175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p179286481175">volume_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p429343721175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p365124961175">Specifies the ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row601770151175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p425000331175">size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p199506681175">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p340521631175">Specifies the snapshot size, in GB.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2096_row380340191175"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2096_p608567071175">updated_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2096_p304462151175">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2096_p416400291175">Specifies the time when the snapshot was updated.</p>
|
||
<p id="evs_04_3059__p133850207816"><span id="evs_04_3059__text186649201488">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3059__li0419202382514"><a name="evs_04_3059__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_3059__evs_04_2013_b1288034833610">error</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3059__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3059__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_3059__evs_04_2013_p19541716103019">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_3059__evs_04_2013_p39375186103019">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_3059__evs_04_2013_p38578950103019">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3059__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2013_p46815658103019">message</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2013_p33971979103019">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3059__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_3059__evs_04_2013_p59870541103019">code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_3059__evs_04_2013_p17675690103019">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_3059__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
||
<p id="evs_04_3059__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_3059__evs_04_2096_li515321001189">Example response<pre class="screen" id="evs_04_3059__screen19633151121814">{
|
||
"count": 4,
|
||
"snapshots": [
|
||
{
|
||
"created_at": "2016-02-16T16:54:14.981520",
|
||
"description": null,
|
||
"id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
|
||
"metadata": { },
|
||
"name": "test01",
|
||
"size": 1,
|
||
"status": "available",
|
||
"volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
|
||
"updated_at": null
|
||
},
|
||
{
|
||
"created_at": "2016-02-16T16:54:19.475397",
|
||
"description": null,
|
||
"id": "83be494d-329e-4a78-8ac5-9af900f48b95",
|
||
"metadata": { },
|
||
"name": "test02",
|
||
"size": 1,
|
||
"status": "available",
|
||
"volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
|
||
"updated_at": null
|
||
},
|
||
{
|
||
"created_at": "2016-02-16T16:54:24.367414",
|
||
"description": null,
|
||
"id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
|
||
"metadata": { },
|
||
"name": "test03",
|
||
"size": 1,
|
||
"status": "available",
|
||
"volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
|
||
"updated_at": null
|
||
},
|
||
{
|
||
"created_at": "2016-02-16T16:54:29.766740",
|
||
"description": null,
|
||
"id": "4c29796a-8cf4-4482-9afc-e66da9a81240",
|
||
"metadata": { },
|
||
"name": "test04",
|
||
"size": 1,
|
||
"status": "available",
|
||
"volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
|
||
"updated_at": null
|
||
}
|
||
],
|
||
"snapshots_links": null
|
||
}</pre>
|
||
<p id="evs_04_3059__evs_04_2096_p52821068113531">or</p>
|
||
<pre class="screen" id="evs_04_3059__evs_04_2096_screen64180398152924">{
|
||
"error": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
<p id="evs_04_3059__evs_04_2096_p5655715720175">In the preceding example, <strong id="evs_04_3059__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_3059__b842352706144438">badRequest</strong> or <strong id="evs_04_3059__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
||
<pre class="screen" id="evs_04_3059__evs_04_2096_screen49676000152949">{
|
||
"itemNotFound": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3059__section4644965111956"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3059__evs_04_2096_ul432542111956"><li id="evs_04_3059__evs_04_2096_li3892879611956">Normal<p id="evs_04_3059__evs_04_2096_p1481484811956"><a name="evs_04_3059__evs_04_2096_li3892879611956"></a><a name="evs_04_2096_li3892879611956"></a>200</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3059__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3059__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>
|
||
|