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>
320 lines
24 KiB
HTML
320 lines
24 KiB
HTML
<a name="evs_04_2096"></a><a name="evs_04_2096"></a>
|
||
|
||
<h1 class="topictitle1">Querying EVS Snapshots</h1>
|
||
<div id="body1489026315011"><div class="section" id="evs_04_2096__section5262172611544"><h4 class="sectiontitle">Function</h4><p id="evs_04_2096__p3450141711544">This API is used to query the EVS snapshots.</p>
|
||
</div>
|
||
<div class="section" id="evs_04_2096__section1511931811555"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2096__ul1670526611555"><li id="evs_04_2096__li1612967411555">URI format<p id="evs_04_2096__p1094933911555"><a name="evs_04_2096__li1612967411555"></a><a name="li1612967411555"></a>GET /v2/{project_id}/snapshots</p>
|
||
</li><li id="evs_04_2096__li3143519211555">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2096__table1448127211555" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2096__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_2096__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_2096__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_2096__p2683384611555">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2096__row2605789011555"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2096__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_2096__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_2096__p4903046711555">Specifies the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_2096__li3777135719593">Request filter parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2096__table633033061168" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2096__row57109071168"><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_2096__p599303181168">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_2096__p225175981168">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.34%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2096__p119861301168">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50.339999999999996%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2096__p313524671168">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2096__row12128142617596"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2096__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_2096__evs_04_2068_p23193765152914">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2096__evs_04_2068_p66755704152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2096__evs_04_2068_p38502923152914"><span id="evs_04_2096__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_2096__row137367471168"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2096__p389347291168">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_2096__p667053841168">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2096__p344270561168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2096__p371281361168">Specifies the offset.</p>
|
||
<div class="note" id="evs_04_2096__note6490498915441"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2096__p4727398915441">This parameter is used when snapshots are queried by page and is used together with the <strong id="evs_04_2096__b842352706185037">limit</strong> parameter. For example, there are a total of 30 snapshots. If you set <strong id="evs_04_2096__b84235270618483">offset</strong> to <strong id="evs_04_2096__b84235270618488">11</strong> and <strong id="evs_04_2096__b842352706184813">limit</strong> to <strong id="evs_04_2096__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_2096__row657177691168"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2096__p215391011168">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_2096__p669456211168">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2096__p538862341168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2096__p27088191168">Specifies the maximum number of query results that can be returned.</p>
|
||
<p id="evs_04_2096__p116811542151"><span id="evs_04_2096__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_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_2096__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
|
||
<p id="evs_04_2096__p1233994321914"><strong id="evs_04_2096__b1293145333103912">GET /v2/</strong><em id="evs_04_2096__i994780625103912">xxx</em><strong id="evs_04_2096__b1828569207103912">/snapshots?limit=50</strong>: Queries the 1–50 snapshots. <strong id="evs_04_2096__b842352706103924">GET /v2/</strong><em id="evs_04_2096__i1514360640103921">xxx</em><strong id="evs_04_2096__b842352706103930">/snapshots?offset=50&limit=50</strong>: Queries the 51–100 snapshots.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2096__row243793751168"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2096__p285723381168">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_2096__p326580131168">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2096__p280534011168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2096__p577330051168">Specifies the snapshot name. This parameter does not support fuzzy search. <span id="evs_04_2096__text894491124201851">The value can contain a maximum of 255 bytes.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2096__row498350041168"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2096__p101035441168">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_2096__p130807691168">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2096__p529093741168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="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_2096__row504462351168"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2096__p596132261168">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_2096__p639420261168">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2096__p119216351168">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50.339999999999996%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2096__p261283481168">Specifies the ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2096__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_2096__p8131165310442">The following example shows how to query the snapshots in the <strong id="evs_04_2096__b102241262254">available</strong> state.</p>
|
||
<ul id="evs_04_2096__ul28722627"><li id="evs_04_2096__li57177053">Example request<pre class="screen" id="evs_04_2096__screen13806089161140">GET https://{endpoint}/v2/{project_id}/snapshots?status=available</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2096__section539031881175"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2096__ul40820781175"><li id="evs_04_2096__li199152681715">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2096__table139122611716" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2096__row139212261178"><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_2096__p592132601710">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_2096__p492026161714">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_2096__p9928266175">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2096__row2925156111719"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2096__p623850141175">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_2096__p200213431175">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_2096__p279846901175">Specifies the snapshot information. For details, see <a href="#evs_04_2096__li367387041175">Parameters in the snapshots field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2096__row892172614170"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2096__p59292621716">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_2096__p9921026101717">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_2096__p693112661716">Specifies the query position marker in the snapshot list. This parameter is at the same level as parameter <strong id="evs_04_2096__b17920052202515">snapshots</strong> in the response body. This parameter is returned only when parameter <strong id="evs_04_2096__b192135232519">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_2096__row7894718155410"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2096__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_2096__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_2096__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2096__li0419202382514">Parameters in the error field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_2096__li367387041175"><a name="evs_04_2096__li367387041175"></a><a name="li367387041175"></a>Parameters in the <strong id="evs_04_2096__b1418141472616">snapshots</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2096__table622128841175" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2096__p574320291175">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="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_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_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_2096__p283450141175">Specifies the snapshot ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_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_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_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_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_2096__p575287091175">Specifies the snapshot name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2096__p592057221175">Specifies the snapshot description.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2096__p183889601175">Specifies the time when the snapshot was created.</p>
|
||
<p id="evs_04_2096__p16450449115618"><span id="evs_04_2096__text8188185355614">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2096__p22339381175">Specifies the snapshot metadata.</p>
|
||
<p id="evs_04_2096__p1678772717473">If <strong id="evs_04_2096__b842352706193018">metadata</strong> contains the <strong id="evs_04_2096__b842352706193021">__system__enableActive</strong> field, the snapshot is automatically created during the backup of a server.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2096__p365124961175">Specifies the ID of the snapshot's source disk.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2096__p340521631175">Specifies the snapshot size, in GB.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="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_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_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_2096__p416400291175">Specifies the time when the snapshot was updated.</p>
|
||
<p id="evs_04_2096__p835995905612"><span id="evs_04_2096__text7360459195618">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_2096__li0419202382514"><a name="evs_04_2096__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2096__evs_04_2013_b1288034833610">error</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2096__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2096__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_2096__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_2096__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_2096__evs_04_2013_p38578950103019">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_2096__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_2096__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_2096__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_2096__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_2096__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_2096__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_2096__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_2096__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
||
<p id="evs_04_2096__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_2096__li515321001189">Example response<pre class="screen" id="evs_04_2096__screen20703801105829">{
|
||
"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_2096__p52821068113531">or</p>
|
||
<pre class="screen" id="evs_04_2096__screen64180398152924">{
|
||
"error": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
<p id="evs_04_2096__p5655715720175">In the preceding example, <strong id="evs_04_2096__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2096__b842352706144438">badRequest</strong> or <strong id="evs_04_2096__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
||
<pre class="screen" id="evs_04_2096__screen49676000152949">{
|
||
"itemNotFound": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2096__section4644965111956"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2096__ul432542111956"><li id="evs_04_2096__li3892879611956">Normal<p id="evs_04_2096__p1481484811956"><a name="evs_04_2096__li3892879611956"></a><a name="li3892879611956"></a>200</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_2096__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2096__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>
|
||
|