forked from docs/doc-exports
Zheng, Xiu
99a2d77599
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
351 lines
23 KiB
HTML
351 lines
23 KiB
HTML
<a name="css_03_0034"></a><a name="css_03_0034"></a>
|
|
|
|
<h1 class="topictitle1">Querying the List of Snapshots</h1>
|
|
<div id="body1522117927446"><div class="section" id="css_03_0034__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0034__p3877173615415">This API is used to query all snapshots of a cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0034__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0034__screen1695846201113">GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0034__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0034__row4445336913"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0034__p54417338910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0034__p1644733693">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0034__p11441233696">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0034__p124403319916">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0034__row94414331098"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0034__p950595565411">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0034__p9444331997">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0034__p144412334919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0034__p18449331896">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row14453320917"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0034__p15505145512547">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0034__p24410331398">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0034__p844133316918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0034__p13441833493">ID of the cluster, to which the snapshot to be queried belongs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0034__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0034__p7963121813448">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0034__section19810103220915"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0034__table134134101673" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="css_03_0034__b1064812306492">backups</strong> field data structure description</caption><thead align="left"><tr id="css_03_0034__row34302108710"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.4.2.2.4.1.1"><p id="css_03_0034__p144309102719">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.2.4.1.2"><p id="css_03_0034__p24306101877">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.32000000000001%" id="mcps1.3.4.2.2.4.1.3"><p id="css_03_0034__p743071010717">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0034__row164441710172"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_03_0034__p11444191010712">backups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_03_0034__p94447103718">Array of <a href="#css_03_0034__table6765160249">backup</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.2.2.4.1.3 "><p id="css_03_0034__p1644420107711">Snapshot list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0034__table6765160249"></a><a name="table6765160249"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0034__table6765160249" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="css_03_0034__b4541190163817">backups</strong> field data structure description</caption><thead align="left"><tr id="css_03_0034__row57631611243"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0034__p187610163246">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0034__p129281642410">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.32000000000001%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0034__p169211162246">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0034__row29241618240"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p29215168244">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p992141620243">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p09212160241">Time when a snapshot is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row79231616245"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p692416122411">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p1292171613246">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p39231615245">Type of the data search engine. For details, see <a href="#css_03_0034__table9975151812430">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row15445112994513"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p174457296455">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p044519292457">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1244512954513">Description of the snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row17462183794515"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p4462113714453">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p1446263784518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1946253714457">ID of the snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row13382104314455"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p13382154317451">clusterId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p538217437459">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1038217438454">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row153531053154617"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p103531553154614">clusterName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p13531553144610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p13531753104613">Cluster name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row1921216589468"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p1221235811463">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p6212185864618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p721235814618">Snapshot name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row1054010424710"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p1754012412474">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p1854015414472">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p35401849476">Snapshot status</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row153529111472"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p1335251114474">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p13352201164714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p535241113478">Indicates whether the snapshot status is updated</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row767013112512"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p5670191117512">backupType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p6670181185113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p76702011105118">Value <strong id="css_03_0034__b168121177380">0</strong> indicates that automatic snapshot creation is enabled. Value <strong id="css_03_0034__b5814151723816">1</strong> indicates that you need to manually create the snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row8107131535110"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p10107315205114">backupMethod</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p151072015125115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p19107151585117">Snapshot creation mode.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row552292193916"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p11522172173916">backupExpectedStartTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p65221121390">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1852214214397">Time when the snapshot starts to be executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row16397122763910"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p4412927153912">backupKeepDay</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p104121727163918">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p141212713397">Snapshot retention period.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row1664782333916"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p106470237399">backupPeriod</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p549441618427">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1264716233396">Time when a snapshot is executed every day.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row7116182019391"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p61161820113914">indices</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p17116152016393">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p2011610205396">Indices that need to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row24021968432"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p184021669438">totalShards</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p540213619436">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1940211644313">Total number of shards of the indices to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row1663716103439"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p56378106431">failedShards</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p46371109436">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p12637110184313">Number of shards that fail to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row93551114124316"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p203551214134319">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p93551148439">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p16355914164319">Version of the snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row12170740154519"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p11704401451">restoreStatus</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p15170440194517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p141701040184513">Snapshot restoration status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row11123144411456"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p1012314454519">startTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p131231244154513">integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p11123204494516">Timestamp when the snapshot starts to be executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row11610164311474"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p261074394711">endTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p2610143154710">integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p11610164319470">Timestamp when the snapshot execution ends.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row138141620104811"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0034__p581412024817">bucketName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0034__p15814182014815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0034__p1081412207482">Bucket for storing snapshot data.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0034__table9975151812430"></a><a name="table9975151812430"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0034__table9975151812430" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0034__b586520391269">datastore</strong> field data structure description</caption><thead align="left"><tr id="css_03_0034__row13150121911438"><th align="left" class="cellrowborder" valign="top" width="21.19211921192119%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0034__p31501719104317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.482148214821482%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0034__p0150319114315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.325732573257326%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0034__p51501519184319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0034__row4150101911430"><td class="cellrowborder" valign="top" width="21.19211921192119%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0034__p5150131914312">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.482148214821482%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0034__p13150101914312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.325732573257326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0034__p121511419174313">Supported type: elasticsearch</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__row12151101984314"><td class="cellrowborder" valign="top" width="21.19211921192119%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0034__p01511719204313">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.482148214821482%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0034__p16151201913437">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.325732573257326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0034__p8151191912439">Engine version number. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0034__section8463633114416"><h4 class="sectiontitle">Examples</h4><p id="css_03_0034__p64419337911">Example request</p>
|
|
<pre class="screen" id="css_03_0034__screen184473316911">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshots</pre>
|
|
<p id="css_03_0034__p17291134711448">Example response</p>
|
|
<pre class="screen" id="css_03_0034__screen14418331595">{
|
|
"backups": [
|
|
{
|
|
"created": "2018-03-07T07:34:47",
|
|
"datastore": {
|
|
"type": "elasticsearch",
|
|
"version": "*.*.*"
|
|
},
|
|
"description": "",
|
|
"id": "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
|
|
"clusterId": "37cb1075-c38e-4cd8-81df-442d52df3786",
|
|
"clusterName": "Es-xfx",
|
|
"name": "snapshot-002",
|
|
"status": "COMPLETED",
|
|
"updated": "2018-03-07T07:40:12",
|
|
"backupType": "1",
|
|
"backupMethod": "manual",
|
|
"backupExpectedStartTime": null,
|
|
"backupKeepDay": null,
|
|
"backupPeriod": null,
|
|
"indices": ".kibana,website2",
|
|
"totalShards": 6,
|
|
"failedShards": 0,
|
|
"version": "6.2.3",
|
|
"restoreStatus": "success",
|
|
"startTime": 1520408087099,
|
|
"endTime": 1520408412219,
|
|
"bucketName": "obs-b8ed"
|
|
},
|
|
{
|
|
"created": "2018-03-06T15:42:37",
|
|
"datastore": {
|
|
"type": "elasticsearch",
|
|
"version": "6.2.3"
|
|
},
|
|
"description": "",
|
|
"id": "29a2254e-947f-4463-b65a-5f0b17515fae",
|
|
"clusterId": "37cb1075-c38e-4cd8-81df-442d52df3786",
|
|
"clusterName": "Es-xfx",
|
|
"name": "snapshot-001",
|
|
"status": "COMPLETED",
|
|
"updated": "2018-03-06T15:48:04",
|
|
"backupType": "1",
|
|
"backupMethod": "manual",
|
|
"backupExpectedStartTime": null,
|
|
"backupKeepDay": null,
|
|
"backupPeriod": null,
|
|
"indices": ".kibana",
|
|
"totalShards": 1,
|
|
"failedShards": 0,
|
|
"version": "6.2.3",
|
|
"restoreStatus": "none",
|
|
"startTime": 1520350957275,
|
|
"endTime": 1520351284357,
|
|
"bucketName": "obs-b8ed"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0034__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0034__p10357103713112"><a href="#css_03_0034__table152931957183117">Table 5</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0034__table152931957183117"></a><a name="table152931957183117"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0034__table152931957183117" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="css_03_0034__en-us_topic_0000001342150609_row194918333132"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0034__en-us_topic_0000001342150609_p6531343171310">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0034__en-us_topic_0000001342150609_p16534124318132">Message</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0034__en-us_topic_0000001342150609_p1453710437131">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0034__en-us_topic_0000001342150609_row09491533111315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0034__en-us_topic_0000001342150609_p1656994351310">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0034__en-us_topic_0000001342150609_p134136431055">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0034__en-us_topic_0000001342150609_p134136431458">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0034__en-us_topic_0000001342150609_row1184954102013"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0034__en-us_topic_0000001342150609_p111841154132019">406</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0034__en-us_topic_0000001342150609_en-us_topic_0122640420_p19980869">Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0034__en-us_topic_0000001342150609_en-us_topic_0122640420_p7837682">The server cannot fulfill the request according to the content characteristics of the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0010.html">Snapshot Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|