doc-exports/docs/css/umn/css_01_0481.html

<a name="css_01_0481"></a><a name="css_01_0481"></a>


  <h1 class="topictitle1">Restoring the Data of an OpenSearch Cluster</h1>

  <div id="body0000001955726522"><p id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li276715741117p0">Restore the data captured by a cluster snapshot to the current cluster or another eligible cluster.</p>
<div class="section" id="css_01_0481__css_01_0266_section79171215132210"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_ul537343941414"><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li187671653184018">Cluster snapshots will increase CPU usage and disk I/O. You are advised to take cluster snapshots during off-peak hours.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li17941828132019">If a cluster is in the <span class="parmname" id="css_01_0481__css_01_0266_parmname81961837154011"><b>Unavailable</b></span> state, you can use the cluster snapshot function only to restore the cluster or view snapshot information.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li19928141414179">While you are creating a snapshot for a cluster or restoring it using one, you can perform certain operations, including scaling out the cluster (except when the cluster is the destination of a restoration operation), accessing Kibana, viewing metrics, and deleting other snapshots. However, you cannot perform the following operations: restarting or deleting the cluster, deleting a snapshot that is in the <strong id="css_01_0481__css_01_0266_css_01_0267_b1784545517509">Creating</strong> or <strong id="css_01_0481__css_01_0266_css_01_0267_b8845175517504">Restoring</strong> state, and creating or restoring another snapshot. While a snapshot is being created or restored for a cluster, any automatic snapshot creation task initiated for that cluster will be canceled.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li21323231302">Cluster data cannot be queried during snapshot restoration.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li61869019106">The destination and source clusters must have the same shards.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li116421184317">The version of the destination cluster must be the same as or later than that of the source cluster.</li></ul>
</div>
<div class="section" id="css_01_0481__css_01_0266_section207841017172319"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0481__css_01_0266_ul1470516593284"><li id="css_01_0481__css_01_0266_li129143033815">The snapshot list contains snapshots whose <strong id="css_01_0481__css_01_0266_b101641456437">Snapshot Status</strong> is <strong id="css_01_0481__css_01_0266_b085013485439">Available</strong>. Storing snapshots in an OBS bucket may incur additional fees. For details, see section "Billing Overview" in <em id="css_01_0481__css_01_0266_i201851812185717">OBS User Guide</em>.</li></ul>
</div>
<div class="section" id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_section16538152014387"><h4 class="sectiontitle">Restoring Data</h4><ol id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_ol842420532406"><li id="css_01_0481__css_01_0266_li158485575103">Log in to the CSS management console.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li928020151910">On the <span class="wintitle" id="css_01_0481__css_01_0266_css_01_0267_en-us_topic_0000001268314505_wintitle145601009549"><b>Clusters</b></span> page, click the name of the target cluster. In the navigation pane on the left, choose <strong id="css_01_0481__css_01_0266_css_01_0267_b17731925141311">Cluster Snapshots</strong>.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li16424353174016">In the <strong id="css_01_0481__css_01_0266_b1506770612112155">Snapshots</strong> area, locate the row that contains the snapshot you want to restore and click <span class="uicontrol" id="css_01_0481__css_01_0266_uicontrol1176334612112155"><b>Restore</b></span> in the <span class="parmname" id="css_01_0481__css_01_0266_parmname869257988112155"><b>Operation</b></span> column.</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li115316101430">On the <strong id="css_01_0481__css_01_0266_b713244478112155">Restore</strong> page, set restoration parameters.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0481__css_01_0266_table125132619300" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Restoration settings</caption><thead align="left"><tr id="css_01_0481__css_01_0266_row195242693014"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.2.4.2.2.3.1.1"><p id="css_01_0481__css_01_0266_p145210263309">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.2.4.2.2.3.1.2"><p id="css_01_0481__css_01_0266_p95232614309">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0481__css_01_0266_row552162612306"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0481__css_01_0266_p3521126123019">Index</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0481__css_01_0266_p14529267301">Specify the name of the index you want to restore.</p>
<p id="css_01_0481__css_01_0266_p885364485710">Constraints:</p>
<ul id="css_01_0481__css_01_0266_ul14857204485715"><li id="css_01_0481__css_01_0266_li1457495018578">The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue88078315118"><b>"\&lt;|&gt;/?</b></span>.</li><li id="css_01_0481__css_01_0266_li14815175595713">When restoring an index whose name is prefixed with <strong id="css_01_0481__css_01_0266_b1596625814110">.kibana</strong>, the index name must be specified.</li><li id="css_01_0481__css_01_0266_li1481518555579">The <strong id="css_01_0481__css_01_0266_b56871981928">.opendistro_security</strong> index cannot be restored.</li></ul>
<p id="css_01_0481__css_01_0266_p159122024165811">Value range:</p>
<ul id="css_01_0481__css_01_0266_ul357110392584"><li id="css_01_0481__css_01_0266_li12865124185813">You can use an asterisk (*) to match multiple indexes. For example, <strong id="css_01_0481__css_01_0266_b107465311723">index*</strong> indicates that all indexes with the prefix <strong id="css_01_0481__css_01_0266_b1774618315211">index</strong> will be restored. When an asterisk (*) is used for index matching, the <strong id="css_01_0481__css_01_0266_b6979115315311">.opendistro_security</strong> index and any system indexes whose name is prefixed with <strong id="css_01_0481__css_01_0266_b76571923142">.kibana</strong> are filtered out by default.</li><li id="css_01_0481__css_01_0266_li9865134135820">You can restore indexes by specifying their names, for example, <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue148652041165817"><b>index1,index2,index3</b></span>.</li></ul>
<p id="css_01_0481__css_01_0266_p1935114112596">Default value:</p>
<p id="css_01_0481__css_01_0266_p714954175910">By default, this parameter is left blank. That is, no index name is specified, and all indexes will be restored.</p>
</td>
</tr>
<tr id="css_01_0481__css_01_0266_row115242613308"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0481__css_01_0266_p145222614305">Rename Pattern</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0481__css_01_0266_p185212693011">Index name matching rule. Enter a regular expression. Indexes that match the regular expression will be restored. The default value <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue1483212953120"><b>index_(.+)</b></span> indicates all indexes. The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue16684173114513"><b>"\&lt;|&gt;/?,</b></span>.</p>
<div class="note" id="css_01_0481__css_01_0266_note849419163219"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0481__css_01_0266_p154991918323">The <span class="parmname" id="css_01_0481__css_01_0266_parmname12472130213378"><b>Rename Pattern</b></span> and <span class="parmname" id="css_01_0481__css_01_0266_parmname9618277293378"><b>Rename Replacement</b></span> take effect only when they are both configured at the same time.</p>
</div></div>
</td>
</tr>
<tr id="css_01_0481__css_01_0266_row175219263308"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0481__css_01_0266_p115212266303">Rename Replacement</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0481__css_01_0266_p11521426113012">Rule for index renaming. The default value <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue1380539963378"><b>restored_index_$1</b></span> indicates that <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue627685363378"><b>restored_</b></span> will be added to the beginning of the names of all restored indexes. The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue0954937165613"><b>"\&lt;|&gt;/?,</b></span>.</p>
<div class="note" id="css_01_0481__css_01_0266_note72451520103217"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0481__css_01_0266_p12451420113220">The <span class="parmname" id="css_01_0481__css_01_0266_parmname165063235213"><b>Rename Pattern</b></span> and <span class="parmname" id="css_01_0481__css_01_0266_parmname965012324524"><b>Rename Replacement</b></span> take effect only when they are both configured at the same time.</p>
</div></div>
</td>
</tr>
<tr id="css_01_0481__css_01_0266_row45219268302"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0481__css_01_0266_p19522264302">Cluster</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0481__css_01_0266_p2065111428326">Select the cluster where you want to restore the data to. You can select the current cluster or another.</p>
<ul id="css_01_0481__css_01_0266_ul19225330115414"><li id="css_01_0481__css_01_0266_li0225173095417">You must specify a cluster whose status is <span class="parmname" id="css_01_0481__css_01_0266_parmname10174206013378"><b>Available</b></span>. If the status of the current cluster is <span class="parmname" id="css_01_0481__css_01_0266_parmname1101508913378"><b>Unavailable</b></span>, you cannot restore the snapshot to the current cluster.</li><li id="css_01_0481__css_01_0266_li222543015413">When you choose to restore data to another cluster, make sure the target cluster has the same or later version than the current cluster, and that the two clusters are in the same region. After a frozen index is restored using a snapshot, the index is stored on the local node and is read-only by default. To make it writable, run the following command to configure the index:<pre class="screen" id="css_01_0481__css_01_0266_screen151451928165410">PUT <em id="css_01_0481__css_01_0266_i14601158155420">index_name</em>/_settings
{
  "index.blocks.write": null
}</pre>
</li><li id="css_01_0481__css_01_0266_li722563012541">If the destination cluster has same-name indexes as the source cluster, data in these indexes will be overwritten. Exercise caution when performing this operation.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_fig128071912118"><span class="figcap"><b>Figure 1 </b>Restoring a snapshot</span><br><span><img id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_image1343149208" src="en-us_image_0000001938218888.png"></span></div>
</li><li id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_li14267162211412">Click <span class="uicontrol" id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_uicontrol2604112619101"><b>OK</b></span>. If restoration succeeds, <span class="parmname" id="css_01_0481__css_01_0266_parmname11512337914"><b>Task Status</b></span> of the snapshot in the snapshot list will change to <span class="parmvalue" id="css_01_0481__css_01_0266_parmvalue1551123318916"><b>Restoration succeeded</b></span>, and the data of indexes is generated according to the snapshot information.<div class="fignone" id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_fig25181595119"><span class="figcap"><b>Figure 2 </b>Successful restoration</span><br><span><img id="css_01_0481__css_01_0266_en-us_topic_0000001268314505_image168371133144215" src="en-us_image_0000001938378264.png"></span></div>
</li></ol>
</div>
</div>

<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0479.html">Backing up and Restoring the Data of an OpenSearch Cluster</a></div>
</div>
</div>