forked from docs/doc-exports
Wuwan, Qi
8675132585
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
211 lines
15 KiB
HTML
211 lines
15 KiB
HTML
<a name="css_03_0033"></a><a name="css_03_0033"></a>
|
|
|
|
<h1 class="topictitle1">Manually Creating a Snapshot</h1>
|
|
<div id="body1522117927446"><div class="section" id="css_03_0033__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0033__p21061341164917">This API is used to manually create a snapshot.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0033__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0033__screen1695846201113">POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0033__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0033__row4445336913"><th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0033__p54417338910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0033__p1644733693">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0033__p11441233696">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0033__p124403319916">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0033__row94414331098"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0033__p0441331398">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0033__p9444331997">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0033__p144412334919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0033__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_0033__row14453320917"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0033__p2044193314920">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0033__p24410331398">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0033__p844133316918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0033__p13441833493">ID of the cluster where index data is to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0033__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0033__p192877964311"><a href="#css_03_0033__table82481020121413">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0033__table82481020121413"></a><a name="table82481020121413"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0033__table82481020121413" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0033__row18248112010149"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0033__p10441033494">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0033__p74493316910">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0033__p1044533896">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0033__p154413335917">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0033__row18248182013148"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0033__p837215054813">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0033__p4441233891">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0033__p186181046114912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0033__p9448924192218">Snapshot name. The snapshot name must start with a letter and contains 4 to 64 characters consisting of only lowercase letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row243315404483"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0033__p1343434015485">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0033__p443424054812">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0033__p1543414094815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0033__p194341340174817">Description of a snapshot. The value contains 0 to 256 characters, and angle brackets (<) and (>) are not allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row1795115595819"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0033__p19952165545814">indices</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0033__p139521155125816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0033__p1995220551584">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0033__p131436419191">Name of the index to be backed up. Multiple index names are separated by commas (,). By default, data of all indices is backed up. You can use the asterisk (*) to back up data of certain indices. For example, if you enter <strong id="css_03_0033__b188021711487">2018-06*</strong>, then data of indices with the name prefix of <strong id="css_03_0033__b16917656184811">2018-06</strong> will be backed up.</p>
|
|
<p id="css_03_0033__p14971123115432">The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0033__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0033__p169741635161715"><a href="#css_03_0033__table4974113513176">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0033__table4974113513176"></a><a name="table4974113513176"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0033__table4974113513176" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="css_03_0033__row8974235191715"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0033__p179743351172">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_0033__p89741735101716">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_0033__p69741435141716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0033__row89745358176"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0033__p1299073511715">backup</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0033__p119901135101715">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0033__p1799083571720">Snapshot object. For details, see <a href="#css_03_0033__table6630232153613">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0033__table6630232153613"></a><a name="table6630232153613"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0033__table6630232153613" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0033__b43077592380">backup</strong> field data structure description</caption><thead align="left"><tr id="css_03_0033__row1630113214366"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0033__p19630143213365">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0033__p963018328366">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.99999999999999%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0033__p4630132123613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0033__row17631173203614"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0033__p16312325361">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0033__p2631153243619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0033__p2063110323363">ID of the snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row341612378413"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0033__p1885390154218">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0033__p685312034214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0033__p9853302428">Snapshot name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0033__section0893774312"><h4 class="sectiontitle">Examples</h4><p id="css_03_0033__p64419337911">Example request</p>
|
|
<pre class="screen" id="css_03_0033__screen7841540829">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot
|
|
{
|
|
"name":"snapshot_001",
|
|
"indices":"myindex1,myindex2",
|
|
"description":""
|
|
}</pre>
|
|
</div>
|
|
<p id="css_03_0033__p73491910185211">Example response</p>
|
|
<pre class="screen" id="css_03_0033__screen1934961010523">{
|
|
"backup":{
|
|
"id" : "9dc4f5c9-33c0-45c7-9378-ae35ae350682",
|
|
"name": "snapshot_101"
|
|
}
|
|
}</pre>
|
|
<div class="section" id="css_03_0033__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0033__p1147144641213"><a href="#css_03_0033__table1728411482811">Table 5</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0033__table1728411482811"></a><a name="table1728411482811"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0033__table1728411482811" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="css_03_0033__row19286184172819"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.8.3.2.4.1.1"><p id="css_03_0033__en-us_topic_0122640420_p51562446">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.8.3.2.4.1.2"><p id="css_03_0033__en-us_topic_0122640420_p15808580">Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.8.3.2.4.1.3"><p id="css_03_0033__en-us_topic_0122640420_p5426640">Status Code Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0033__row132861042286"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.1 "><p id="css_03_0033__p1128617411288">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.2 "><p id="css_03_0033__en-us_topic_0122640420_p58675139">Created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.3 "><p id="css_03_0033__en-us_topic_0122640420_p55065844">The request for creating a resource has been fulfilled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row102861341287"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.1 "><p id="css_03_0033__p132862452815">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.2 "><p id="css_03_0033__en-us_topic_0122640420_p5333744">InternalServerError</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.3 "><p id="css_03_0033__en-us_topic_0122640420_p29380125">The server is able to receive the request but it could not understand the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row7286641285"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.1 "><p id="css_03_0033__p162861349281">406</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.2 "><p id="css_03_0033__en-us_topic_0122640420_p19980869">Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.3 "><p id="css_03_0033__en-us_topic_0122640420_p7837682">The server cannot fulfill the request according to the content characteristics of the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row92861142287"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.1 "><p id="css_03_0033__p2028654202814">501</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.2 "><p id="css_03_0033__en-us_topic_0122640420_p35800417">Not Implemented</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.3 "><p id="css_03_0033__en-us_topic_0122640420_p14152689">The server does not support the requested function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row54071148132818"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.1 "><p id="css_03_0033__p13407184815280">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.2 "><p id="css_03_0033__en-us_topic_0122640420_p50789473">Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.3 "><p id="css_03_0033__en-us_topic_0122640420_p20306648">The server understood the request, but is refusing to fulfill it.</p>
|
|
<p id="css_03_0033__en-us_topic_0122640420_p48542107">The client should not repeat the request without modifications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0033__row111035537283"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.1 "><p id="css_03_0033__p4103105342812">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.2 "><p id="css_03_0033__en-us_topic_0122640420_p11193990">BadRequest</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.8.3.2.4.1.3 "><p id="css_03_0033__en-us_topic_0122640420_p34297999">Invalid request.</p>
|
|
<p id="css_03_0033__en-us_topic_0122640420_p40246543">The client should not repeat the request without modifications.</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>
|
|
|