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

<a name="css_01_0480"></a><a name="css_01_0480"></a>

<h1 class="topictitle1">Creating a Snapshot to Back Up the Data of an OpenSearch Cluster</h1>
<div id="body0000001992165625"><p id="css_01_0480__css_01_0267_p122661429192717">This topic describes two ways to create snapshots to back up a CSS cluster: automatic and manual.</p>
<div class="section" id="css_01_0480__css_01_0267_section148904549202"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0480__css_01_0267_ul84697516211"><li id="css_01_0480__css_01_0267_li1646918502114">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_0480__css_01_0267_li346935112115">If a cluster is in the <span class="parmname" id="css_01_0480__css_01_0267_parmname84701659218"><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_0480__css_01_0267_li1647095112116">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_0480__b20505221652455">Creating</strong> or <strong id="css_01_0480__b15746999522455">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_0480__css_01_0267_li144702517217">The first snapshot of a cluster is a full snapshot, and subsequent snapshots are incremental ones. CSS snapshot files depend on one another.</li></ul>
</div>
<div class="section" id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_section914018211934"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0480__css_01_0267_ul1470516593284"><li id="css_01_0480__css_01_0267_li129143033815">You have created an OBS bucket for storing snapshots. Storing snapshots in an OBS bucket may incur additional fees. For details, see section "Billing Overview" in <em id="css_01_0480__i1852172712595">OBS User Guide</em>.</li></ul>
</div>
<div class="section" id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_section18551039928"><h4 class="sectiontitle">Setting Automatic Snapshot Creation</h4><ol id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_ol1072514121135"><li id="css_01_0480__css_01_0267_li9695184344814">Log in to the <span id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_text6466211316">CSS</span> management console.</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li07251912434">Enable automatic snapshot creation for a cluster. You can enable automatic snapshot creation when creating a new cluster. For details, see <a href="css_01_0275.html#css_01_0275__en-us_topic_0000001268594549_li692975642819">7</a>. Alternatively, you can do that for an existing cluster.<ul id="css_01_0480__css_01_0267_ul3933144015018"><li id="css_01_0480__css_01_0267_li1093315404508">If automatic snapshot creation has been enabled during cluster creation, go to <a href="#css_01_0480__css_01_0267_li1177820461620">7</a>.</li><li id="css_01_0480__css_01_0267_li1907111135114">To enable automatic snapshot creation after a cluster is already created, go to the next step.</li></ul>
</li><li id="css_01_0480__css_01_0267_li13509422165312">On the <span class="wintitle" id="css_01_0480__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_0480__b137981936775344">Cluster Snapshots</strong>.</li><li id="css_01_0480__css_01_0267_li8875103325518">On the displayed <span class="wintitle" id="css_01_0480__wintitle84264515437"><b>Cluster Snapshots</b></span> page, click the icon to the right of <span class="parmname" id="css_01_0480__parmname1342613511433"><b>Cluster Snapshot</b></span> to enable the cluster snapshot function. If it is already enabled, skip this step.<p id="css_01_0480__css_01_0267_p83194214166">CSS will automatically create an OBS bucket and IAM agency for snapshot storage. The automatically created OBS bucket and IAM agency will be displayed on the page.</p>
<p id="css_01_0480__css_01_0267_p16603143412556">To modify them, click <span><img id="css_01_0480__css_01_0267_image1783131135520" src="en-us_image_0000002124388336.png"></span> on the right of <strong id="css_01_0480__b72711318075344">Basic Configuration</strong> to edit the configuration. After the OBS bucket is changed, the cluster obtains snapshot data from the new bucket. To ensure the data security of your snapshots, you can choose to encrypt them.</p>

<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0480__table1112132625610" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Basic configuration for a cluster snapshot policy</caption><thead align="left"><tr id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_row74671830133417"><th align="left" class="cellrowborder" valign="top" width="16.900000000000002%" id="mcps1.3.4.2.4.5.2.3.1.1"><p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p2467330133420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="83.1%" id="mcps1.3.4.2.4.5.2.3.1.2"><p id="css_01_0480__css_01_0275_p175381433420">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_row1646743016348"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.4.5.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p5467163016341">OBS Bucket</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.4.5.2.3.1.2 "><p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p2046713013344">Select an OBS bucket for storing snapshots from the drop-down list box. You can also click <strong id="css_01_0480__css_01_0275_b139506154074316">Create Bucket</strong> on the right to create a new OBS bucket. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual/obs/en-us_topic_0045853662.html" target="_blank" rel="noopener noreferrer">Creating a Bucket</a>.</p>
<p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p169581927104917">The newly created or existing OBS bucket must meet the following requirements:</p>
<ul id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_ul196015276499"><li id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_li1496042724916"><span class="parmname" id="css_01_0480__css_01_0275_parmname122703507274316"><b>Storage Class</b></span> is <span class="parmvalue" id="css_01_0480__css_01_0275_parmvalue112353646974316"><b>Standard</b></span> or <strong id="css_01_0480__css_01_0275_b119644168774316">Warm</strong>.</li><li id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_li8114122084513"><strong id="css_01_0480__css_01_0275_b89699874074316">Region</strong> must be the same as that of the created cluster.</li></ul>
</td>
</tr>
<tr id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_row10467830183414"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.4.5.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p146718309347">Backup Path</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.4.5.2.3.1.2 "><p id="css_01_0480__css_01_0275_p14549143141">Storage path of the snapshot in the OBS bucket.</p>
<div class="p" id="css_01_0480__css_01_0275_p354994315411">The backup path cannot:<ul id="css_01_0480__css_01_0275_ul15491443747"><li id="css_01_0480__css_01_0275_li35497431441">Contain the following characters: \:*?"&lt;&gt;|'{}</li><li id="css_01_0480__css_01_0275_li175494431642">Start with a slash (/).</li><li id="css_01_0480__css_01_0275_li1549154316411">Start or end with a period (.).</li><li id="css_01_0480__css_01_0275_li55491443748">Contain more than two consecutive slashes (/) or periods (.).</li><li id="css_01_0480__css_01_0275_li4549443942">Exceed 512 characters.</li></ul>
</div>
</td>
</tr>
<tr id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_row94671530153410"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.4.5.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p13467330103415">IAM Agency</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.4.5.2.3.1.2 "><p id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p194671630143411">IAM agency authorized by the current account for <span id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_text18259161053619">CSS</span> to access or maintain data stored in OBS. If no agency is available, contact the CSS administrator to create one. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual/iam/en-us_topic_0046613147.html" target="_blank" rel="noopener noreferrer">Creating an Agency</a>.</p>
<div class="p" id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_p15960122764916">The selected IAM agency must meet the following requirements:<ul id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_ul29611827194917"><li id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_li1896011275492"><span class="parmname" id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_parmname1296072754913"><b>Agency Type</b></span> must be <span class="parmvalue" id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_parmvalue1096092710492"><b>Cloud service</b></span>.</li><li id="css_01_0480__css_01_0275_css_01_0380_en-us_topic_0000001268594549_li696032784920">Set <strong id="css_01_0480__css_01_0275_b145884483374316">Cloud Service</strong> to <strong id="css_01_0480__css_01_0275_b48078911174316">CSS</strong>.</li><li id="css_01_0480__css_01_0275_css_01_0380_li8420124922810">Mandatory policies: <span class="parmname" id="css_01_0480__css_01_0275_parmname114807859974316"><b>Tenant Administrator</b></span> or <span class="parmname" id="css_01_0480__css_01_0275_parmname161813801174316"><b>OBS Administrator</b></span>.</li></ul>
</div>
<div class="note" id="css_01_0480__css_01_0275_css_01_0380_note471411126378"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0480__css_01_0275_css_01_0380_p671411121377">The agency name can contain only letters (case-sensitive), digits, underscores (_), and hyphens (-). Otherwise, the backup will fail.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="css_01_0480__en-us_topic_0000001268314505_fig5965112764919"><span class="figcap"><b>Figure 1 </b>Edit Basic Configuration</span><br><span><img id="css_01_0480__en-us_topic_0000001268314505_image1143918271686" src="en-us_image_0000002129414032.png"></span></div>
</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li2251154818503">Enable automatic snapshot creation. The <strong id="css_01_0480__b166270278775344">Configure Automatic Snapshot Creation</strong> dialog box is displayed. If automatic snapshot creation is enabled, you can click <span><img id="css_01_0480__image107515745775344" src="en-us_image_0000001938218836.png"></span> on the right of <strong id="css_01_0480__b79665256375344">Automatic Snapshot Creation</strong> to modify the snapshot policy.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0480__css_01_0267_en-us_topic_0000001268594549_table179407117910" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Setting automatic snapshot creation</caption><thead align="left"><tr id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_row1694013111396"><th align="left" class="cellrowborder" valign="top" width="16.900000000000002%" id="mcps1.3.4.2.5.4.2.3.1.1"><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p994001118917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="83.1%" id="mcps1.3.4.2.5.4.2.3.1.2"><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p159404111593">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_row494351116910"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.5.4.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p189432011894">Snapshot Name Prefix</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.5.4.2.3.1.2 "><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p1194311117917">The snapshot name prefix contains 1 to 32 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. A snapshot name consists of a snapshot name prefix and a timestamp, for example, <strong id="css_01_0480__b183958182775344">snapshot-1566921603720</strong>.</p>
</td>
</tr>
<tr id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_row69433112092"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.5.4.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p6943181111912">Time Zone</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.5.4.2.3.1.2 "><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p129431110916">Time zone for the backup time. Specify <span class="parmname" id="css_01_0480__parmname149102163574319"><b>Backup Started Time</b></span> based on the time zone.</p>
</td>
</tr>
<tr id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_row79432111592"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.5.4.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p9943141118920">Backup Start Time</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.5.4.2.3.1.2 "><p id="css_01_0480__css_01_0275_css_01_0267_en-us_topic_0000001268594549_p18943151116919">The time when the backup starts automatically every day. You can specify this parameter only in full hours, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select a time from the drop-down list.</p>
</td>
</tr>
<tr id="css_01_0480__css_01_0275_css_01_0267_row5853133216216"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.5.4.2.3.1.1 "><p id="css_01_0480__css_01_0275_css_01_0267_p1085419321228">Index</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.5.4.2.3.1.2 "><p id="css_01_0480__css_01_0275_css_01_0267_p73101050123">Indexes that you want to back up using snapshots. The index names cannot contain spaces or uppercase letters, and cannot contain <span class="parmvalue" id="css_01_0480__css_01_0267_parmvalue1185123212475"><b>"\&lt;|&gt;/?</b></span>. Use commas (,) to separate different index names. If you do not specify this parameter, all indexes in the cluster are backed up by default. You can use the asterisk (<span class="parmname" id="css_01_0480__parmname176457600174319"><b>*</b></span>) to match multiple indexes. For example, if you enter <strong id="css_01_0480__b28588703374319">index*</strong>, then the data of all indexes whose names are prefixed with <strong id="css_01_0480__b26319361074319">index</strong> will be backed up.</p>
<div class="note" id="css_01_0480__css_01_0275_css_01_0267_note3869801317"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0480__css_01_0275_css_01_0267_p1412314714220">Run the <b><span class="cmdname" id="css_01_0480__css_01_0275_css_01_0267_cmdname588215101430">GET /_cat/indices</span></b> command in Kibana to query the names of all indexes in the cluster.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_fig1797311351298"><span class="figcap"><b>Figure 2 </b>Automatic snapshot creation</span><br><span><img id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_image890613211913" src="en-us_image_0000002124546468.png"></span></div>
</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li175372485117">Click <strong id="css_01_0480__b9596787675344">OK</strong> to save the snapshot policy.</li><li id="css_01_0480__css_01_0267_li1177820461620"><a name="css_01_0480__css_01_0267_li1177820461620"></a><a name="css_01_0267_li1177820461620"></a>Snapshots that are automatically created according to the snapshot policy are displayed in the snapshot list, along with manually created snapshots. You can distinguish between them based on <strong id="css_01_0480__b31491124775344">Snapshot Type</strong>. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots.</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li48981519132317">(Optional) Disable automatic snapshot creation.<p id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_p622541042417"><a name="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li48981519132317"></a><a name="css_01_0267_en-us_topic_0000001268314505_li48981519132317"></a>After you disable automatic snapshot creation, the system stops automatic creation of snapshots. If the system is creating a snapshot based on the automatic snapshot creation policy and the snapshot is not yet displayed in the snapshot list, you cannot disable automatic snapshot creation. In this case, if you click the button next to <strong id="css_01_0480__b199347709975344">Automatic Snapshot Creation</strong>, a message is displayed, indicating that you cannot disable the function. You are advised to disable the function after the system completes automatic creation of the snapshot, and the created snapshot is displayed in the snapshot list.</p>
<p id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_p196228429309">When disabling automatic snapshot creation, you can choose whether to delete the snapshots that have been automatically created by selecting <span class="parmname" id="css_01_0480__parmname19549642114812"><b>Delete automated snapshots</b></span> in the displayed dialog box. By default, automatically created snapshots are not deleted.</p>
<ul id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_ul599135212309"><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li5991052103012">If you do not select <span class="parmname" id="css_01_0480__parmname89514482575344"><b>Delete automated snapshots</b></span>, automatically created snapshots will not be deleted when you disable automatic snapshot creation. You can manually delete them later. For details, see <a href="css_01_0482.html">Deleting an OpenSearch Cluster Snapshot</a>. If you do not manually delete the automatically created snapshots but later enable automatic snapshot creation again, then all these snapshots (with <span class="parmname" id="css_01_0480__parmname208977863975344"><b>Snapshot Type</b></span> set to <strong id="css_01_0480__b89668365775344">Automated</strong> in the snapshot list of the cluster) can only be automatically deleted by the system. The system automatically deletes snapshots based on the policy the user configured when enabling automatic snapshot creation. For example, if the number of retained snapshots is set to <strong id="css_01_0480__b193083833775344">10</strong> in this policy and more than 10 snapshots are created, the system automatically deletes the excess snapshots on the half hour.</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li989615428317">If you select <span class="parmname" id="css_01_0480__parmname4527187275344"><b>Delete automated snapshots</b></span>, all snapshots with <span class="parmname" id="css_01_0480__parmname81127164175344"><b>Snapshot Type</b></span> set to <strong id="css_01_0480__b176313836775344">Automated</strong> in the snapshot list will be deleted when you disable automatic snapshot creation.</li></ul>
<div class="note" id="css_01_0480__css_01_0267_note8383183603214"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0480__css_01_0267_p738453653212">If snapshots are disabled, existing snapshots will not be automatically deleted. If you need to delete these snapshots, do that in the bucket that stores them on the OBS console.</p>
</div></div>
</li></ol>
</div>
<div class="section" id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_section43906502025"><a name="css_01_0480__css_01_0267_en-us_topic_0000001268314505_section43906502025"></a><a name="css_01_0267_en-us_topic_0000001268314505_section43906502025"></a><h4 class="sectiontitle">Manually Creating a Snapshot</h4><ol id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_ol1597157201819"><li id="css_01_0480__css_01_0267_li158485575103">Log in to the CSS management console.</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li928020151910">On the <span class="wintitle" id="css_01_0480__wintitle1388600295"><b>Clusters</b></span> page, click the name of the target cluster. In the navigation pane on the left, choose <strong id="css_01_0480__b1350039234">Cluster Snapshots</strong>.</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li05161823125719">On the displayed <span class="wintitle" id="css_01_0480__css_01_0480_wintitle84264515437"><b>Cluster Snapshots</b></span> page, click the icon to the right of <span class="parmname" id="css_01_0480__css_01_0480_parmname1342613511433"><b>Cluster Snapshot</b></span> to enable the cluster snapshot function. If it is already enabled, skip this step.<p id="css_01_0480__css_01_0480_css_01_0267_p83194214166">CSS will automatically create an OBS bucket and IAM agency for snapshot storage. The automatically created OBS bucket and IAM agency will be displayed on the page.</p>
<p id="css_01_0480__css_01_0480_css_01_0267_p16603143412556">To modify them, click <span><img id="css_01_0480__css_01_0480_css_01_0267_image1783131135520" src="en-us_image_0000002124388336.png"></span> on the right of <strong id="css_01_0480__css_01_0480_b72711318075344">Basic Configuration</strong> to edit the configuration. After the OBS bucket is changed, the cluster obtains snapshot data from the new bucket. To ensure the data security of your snapshots, you can choose to encrypt them.</p>

<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0480__css_01_0480_table1112132625610" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Basic configuration for a cluster snapshot policy</caption><thead align="left"><tr id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_row74671830133417"><th align="left" class="cellrowborder" valign="top" width="16.900000000000002%" id="mcps1.3.5.2.3.5.2.3.1.1"><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p2467330133420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="83.1%" id="mcps1.3.5.2.3.5.2.3.1.2"><p id="css_01_0480__css_01_0480_css_01_0275_p175381433420">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_row1646743016348"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.5.2.3.5.2.3.1.1 "><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p5467163016341">OBS Bucket</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.5.2.3.5.2.3.1.2 "><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p2046713013344">Select an OBS bucket for storing snapshots from the drop-down list box. You can also click <strong id="css_01_0480__css_01_0480_css_01_0275_b139506154074316">Create Bucket</strong> on the right to create a new OBS bucket. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual/obs/en-us_topic_0045853662.html" target="_blank" rel="noopener noreferrer">Creating a Bucket</a>.</p>
<p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p169581927104917">The newly created or existing OBS bucket must meet the following requirements:</p>
<ul id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_ul196015276499"><li id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_li1496042724916"><span class="parmname" id="css_01_0480__css_01_0480_css_01_0275_parmname122703507274316"><b>Storage Class</b></span> is <span class="parmvalue" id="css_01_0480__css_01_0480_css_01_0275_parmvalue112353646974316"><b>Standard</b></span> or <strong id="css_01_0480__css_01_0480_css_01_0275_b119644168774316">Warm</strong>.</li><li id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_li8114122084513"><strong id="css_01_0480__css_01_0480_css_01_0275_b89699874074316">Region</strong> must be the same as that of the created cluster.</li></ul>
</td>
</tr>
<tr id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_row10467830183414"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.5.2.3.5.2.3.1.1 "><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p146718309347">Backup Path</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.5.2.3.5.2.3.1.2 "><p id="css_01_0480__css_01_0480_css_01_0275_p14549143141">Storage path of the snapshot in the OBS bucket.</p>
<div class="p" id="css_01_0480__css_01_0480_css_01_0275_p354994315411">The backup path cannot:<ul id="css_01_0480__css_01_0480_css_01_0275_ul15491443747"><li id="css_01_0480__css_01_0480_css_01_0275_li35497431441">Contain the following characters: \:*?"&lt;&gt;|'{}</li><li id="css_01_0480__css_01_0480_css_01_0275_li175494431642">Start with a slash (/).</li><li id="css_01_0480__css_01_0480_css_01_0275_li1549154316411">Start or end with a period (.).</li><li id="css_01_0480__css_01_0480_css_01_0275_li55491443748">Contain more than two consecutive slashes (/) or periods (.).</li><li id="css_01_0480__css_01_0480_css_01_0275_li4549443942">Exceed 512 characters.</li></ul>
</div>
</td>
</tr>
<tr id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_row94671530153410"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.5.2.3.5.2.3.1.1 "><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p13467330103415">IAM Agency</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.5.2.3.5.2.3.1.2 "><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p194671630143411">IAM agency authorized by the current account for <span id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_text18259161053619">CSS</span> to access or maintain data stored in OBS. If no agency is available, contact the CSS administrator to create one. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual/iam/en-us_topic_0046613147.html" target="_blank" rel="noopener noreferrer">Creating an Agency</a>.</p>
<div class="p" id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_p15960122764916">The selected IAM agency must meet the following requirements:<ul id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_ul29611827194917"><li id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_li1896011275492"><span class="parmname" id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_parmname1296072754913"><b>Agency Type</b></span> must be <span class="parmvalue" id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_parmvalue1096092710492"><b>Cloud service</b></span>.</li><li id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_en-us_topic_0000001268594549_li696032784920">Set <strong id="css_01_0480__css_01_0480_css_01_0275_b145884483374316">Cloud Service</strong> to <strong id="css_01_0480__css_01_0480_css_01_0275_b48078911174316">CSS</strong>.</li><li id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_li8420124922810">Mandatory policies: <span class="parmname" id="css_01_0480__css_01_0480_css_01_0275_parmname114807859974316"><b>Tenant Administrator</b></span> or <span class="parmname" id="css_01_0480__css_01_0480_css_01_0275_parmname161813801174316"><b>OBS Administrator</b></span>.</li></ul>
</div>
<div class="note" id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_note471411126378"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0480__css_01_0480_css_01_0275_css_01_0380_p671411121377">The agency name can contain only letters (case-sensitive), digits, underscores (_), and hyphens (-). Otherwise, the backup will fail.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="css_01_0480__css_01_0480_en-us_topic_0000001268314505_fig5965112764919"><span class="figcap"><b>Figure 3 </b>Edit Basic Configuration</span><br><span><img id="css_01_0480__css_01_0480_en-us_topic_0000001268314505_image1143918271686" src="en-us_image_0000002129414032.png"></span></div>
</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li328516081910">After basic configurations are completed, click <strong id="css_01_0480__b120185870174319">Create</strong> to manually create a snapshot.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0480__css_01_0267_table1160215248166" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters for manually creating a snapshot</caption><thead align="left"><tr id="css_01_0480__css_01_0267_row12602132418164"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.4.2.2.3.1.1"><p id="css_01_0480__css_01_0267_p186021324181617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.4.2.2.3.1.2"><p id="css_01_0480__css_01_0267_p1160252410161">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0480__css_01_0267_row17602024191612"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0480__css_01_0267_p1560272413166">Snapshot Name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0480__css_01_0267_p5602424131612">Name of a manually created snapshot. It can contain 4 to 64 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. For snapshots you create manually, you can specify the snapshot name. The system will not automatically add a timestamp to the snapshot name.</p>
</td>
</tr>
<tr id="css_01_0480__css_01_0267_row17602024131612"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0480__css_01_0267_p360214246164">Index</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0480__css_01_0267_css_01_0267_p73101050123">Indexes that you want to back up using snapshots. The index names cannot contain spaces or uppercase letters, and cannot contain <span class="parmvalue" id="css_01_0480__parmvalue1999501522"><b>"\&lt;|&gt;/?</b></span>. Use commas (,) to separate different index names. If you do not specify this parameter, all indexes in the cluster are backed up by default. You can use the asterisk (<span class="parmname" id="css_01_0480__parmname52337307974319"><b>*</b></span>) to match multiple indexes. For example, if you enter <strong id="css_01_0480__b171356569574319">index*</strong>, then the data of all indexes whose names are prefixed with <strong id="css_01_0480__b3886087374319">index</strong> will be backed up.</p>
<div class="note" id="css_01_0480__css_01_0267_css_01_0267_note3869801317"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0480__css_01_0267_css_01_0267_p1412314714220">Run the <b><span class="cmdname" id="css_01_0480__css_01_0267_css_01_0267_cmdname588215101430">GET /_cat/indices</span></b> command in Kibana to query the names of all indexes in the cluster.</p>
</div></div>
</td>
</tr>
<tr id="css_01_0480__css_01_0267_row13603182471620"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0480__css_01_0267_p1960302413166">Description</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0480__css_01_0267_p060302412166">Description of the snapshot. The value contains 0 to 256 characters and cannot contain <span class="parmname" id="css_01_0480__css_01_0267_parmname1887617382174"><b>&lt;&gt;</b></span>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_li162011519182916">Click <strong id="css_01_0480__b28096933074319">OK</strong> to create the snapshot.<p id="css_01_0480__css_01_0267_en-us_topic_0000001268314505_p522415013344">After the snapshot is created, it is displayed in the snapshot list. The status <strong id="css_01_0480__b80151276274319">Available</strong> indicates that the snapshot is created successfully. along with manually created snapshots. You can distinguish between them based on <strong id="css_01_0480__b927692603">Snapshot Type</strong>. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots.</p>
</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>