removing dis from zuul.yaml

Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: lizaoxu <lizaoxu@huawei.com>
Co-committed-by: lizaoxu <lizaoxu@huawei.com>

docs/asm/api-ref/ALL_META.TXT.json

@@ -49,8 +49,8 @@
 		"search_title":"",
 		"metedata":[
 			{
-				"prodname":"asm",
-				"documenttype":"api"
+				"documenttype":"api",
+				"prodname":"asm"
 			}
 		],
 		"title":"Service Mesh APIs",
@@ -61,14 +61,14 @@
 		"node_id":"asm_api_0101.xml",
 		"product_code":"asm",
 		"code":"4",
-		"des":"This API is used to create a service mesh.POST /v1/meshesStatus code: 201Status code: 400Status code: 409Status code: 500Creating a service meshStatus code: 201The servic",
+		"des":"This API is used to create a service mesh.POST /v1/{project_id}/meshesStatus code: 201Status code: 400Status code: 409Status code: 500Creating a service meshStatus code: ",
 		"doc_type":"api",
 		"kw":"Creating a Service Mesh,Service Mesh APIs,API Reference",
 		"search_title":"",
 		"metedata":[
 			{
-				"prodname":"asm",
-				"documenttype":"api"
+				"documenttype":"api",
+				"prodname":"asm"
 			}
 		],
 		"title":"Creating a Service Mesh",
@@ -79,14 +79,14 @@
 		"node_id":"asm_api_0102.xml",
 		"product_code":"asm",
 		"code":"5",
-		"des":"This API is used to delete a service mesh.DELETE /v1/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus code: 200The service mesh ",
+		"des":"This API is used to delete a service mesh.DELETE /v1/{project_id}/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus code: 200The ",
 		"doc_type":"api",
 		"kw":"Deleting a Service Mesh,Service Mesh APIs,API Reference",
 		"search_title":"",
 		"metedata":[
 			{
-				"prodname":"asm",
-				"documenttype":"api"
+				"documenttype":"api",
+				"prodname":"asm"
 			}
 		],
 		"title":"Deleting a Service Mesh",
@@ -97,14 +97,14 @@
 		"node_id":"asm_api_0103.xml",
 		"product_code":"asm",
 		"code":"6",
-		"des":"This API is used to obtain details about a service mesh.GET /v1/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus code: 200The de",
+		"des":"This API is used to obtain details about a service mesh.GET /v1/{project_id}/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus co",
 		"doc_type":"api",
 		"kw":"Querying a Service Mesh,Service Mesh APIs,API Reference",
 		"search_title":"",
 		"metedata":[
 			{
-				"prodname":"asm",
-				"documenttype":"api"
+				"documenttype":"api",
+				"prodname":"asm"
 			}
 		],
 		"title":"Querying a Service Mesh",
@@ -115,14 +115,14 @@
 		"node_id":"asm_api_0104.xml",
 		"product_code":"asm",
 		"code":"7",
-		"des":"This API is used to obtain details about all service meshes.GET /v1/meshesStatus code: 200Status code: 400Status code: 500NoneStatus code: 200The details about all servic",
+		"des":"This API is used to obtain details about all service meshes.GET /v1/{project_id}/meshesStatus code: 200Status code: 400Status code: 500NoneStatus code: 200The details abo",
 		"doc_type":"api",
 		"kw":"Querying the Service Mesh List,Service Mesh APIs,API Reference",
 		"search_title":"",
 		"metedata":[
 			{
-				"prodname":"asm",
-				"documenttype":"api"
+				"documenttype":"api",
+				"prodname":"asm"
 			}
 		],
 		"title":"Querying the Service Mesh List",

docs/asm/api-ref/CLASS.TXT.json

@@ -27,7 +27,7 @@
 		"code":"3"
 	},
 	{
-		"desc":"This API is used to create a service mesh.POST /v1/meshesStatus code: 201Status code: 400Status code: 409Status code: 500Creating a service meshStatus code: 201The servic",
+		"desc":"This API is used to create a service mesh.POST /v1/{project_id}/meshesStatus code: 201Status code: 400Status code: 409Status code: 500Creating a service meshStatus code: ",
 		"product_code":"asm",
 		"title":"Creating a Service Mesh",
 		"uri":"asm_api_0101.html",
@@ -36,7 +36,7 @@
 		"code":"4"
 	},
 	{
-		"desc":"This API is used to delete a service mesh.DELETE /v1/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus code: 200The service mesh ",
+		"desc":"This API is used to delete a service mesh.DELETE /v1/{project_id}/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus code: 200The ",
 		"product_code":"asm",
 		"title":"Deleting a Service Mesh",
 		"uri":"asm_api_0102.html",
@@ -45,7 +45,7 @@
 		"code":"5"
 	},
 	{
-		"desc":"This API is used to obtain details about a service mesh.GET /v1/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus code: 200The de",
+		"desc":"This API is used to obtain details about a service mesh.GET /v1/{project_id}/meshes/{mesh_id}Status code: 200Status code: 400Status code: 404Status code: 500NoneStatus co",
 		"product_code":"asm",
 		"title":"Querying a Service Mesh",
 		"uri":"asm_api_0103.html",
@@ -54,7 +54,7 @@
 		"code":"6"
 	},
 	{
-		"desc":"This API is used to obtain details about all service meshes.GET /v1/meshesStatus code: 200Status code: 400Status code: 500NoneStatus code: 200The details about all servic",
+		"desc":"This API is used to obtain details about all service meshes.GET /v1/{project_id}/meshesStatus code: 200Status code: 400Status code: 500NoneStatus code: 200The details abo",
 		"product_code":"asm",
 		"title":"Querying the Service Mesh List",
 		"uri":"asm_api_0104.html",

docs/asm/api-ref/asm_api_0021.html

@@ -8,7 +8,19 @@
 </th>
 </tr>
 </thead>
-<tbody><tr id="asm_api_0021__row158031552498"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p4804952394">2025-03-07</p>
+<tbody><tr id="asm_api_0021__row14384430051"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p28621736552">2025-06-24</p>
+</td>
+<td class="cellrowborder" valign="top" width="75.69%" headers="mcps1.3.1.1.3.1.2 "><p id="asm_api_0021__p13862153612515">API updates:</p>
+<ul id="asm_api_0021__ul1486214362056"><li id="asm_api_0021__li18862123610519">Deleted <strong id="asm_api_0021__b26497598814">metrics</strong> and <strong id="asm_api_0021__b1978455584">accessLogging</strong> from all APIs.</li><li id="asm_api_0021__li6862336354">Deleted <strong id="asm_api_0021__b17461163815913">metrics</strong> and <strong id="asm_api_0021__b1950510424912">accessLogging</strong> from all example responses.</li></ul>
+</td>
+</tr>
+<tr id="asm_api_0021__row11299185321914"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p16299195310194">2025-05-06</p>
+</td>
+<td class="cellrowborder" valign="top" width="75.69%" headers="mcps1.3.1.1.3.1.2 "><p id="asm_api_0021__p1038213368222">API updates:</p>
+<ul id="asm_api_0021__ul1738314361228"><li id="asm_api_0021__li83831036112210">Modified API URIs.</li><li id="asm_api_0021__li47221519142314">Modified request and response parameters.</li><li id="asm_api_0021__li338311364220">Modified request and response examples.</li></ul>
+</td>
+</tr>
+<tr id="asm_api_0021__row158031552498"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p4804952394">2025-03-07</p>
 </td>
 <td class="cellrowborder" valign="top" width="75.69%" headers="mcps1.3.1.1.3.1.2 "><p id="asm_api_0021__p16804252798">Deleted duplicate links in <a href="asm_api_0012.html">API</a>.</p>
 </td>

docs/cbr/api-ref/ALL_META.TXT.json

@@ -523,7 +523,7 @@
 		"node_id":"listbackups.xml",
 		"product_code":"cbr",
 		"code":"27",
-		"des":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.",
+		"des":"This API is used to query all backups.If you want to create a backup, create a Restore Point.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes",
 		"doc_type":"api",
 		"kw":"Querying All Backups,Backups,API Reference",
 		"search_title":"",
@@ -563,7 +563,7 @@
 		"node_id":"showbackup.xml",
 		"product_code":"cbr",
 		"code":"29",
-		"des":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.",
+		"des":"This API is used to query the backup of a specific ID.If you want to create a backup, create a Restore Point.GET /v3/{project_id}/backups/{backup_id}Status code: 200Statu",
 		"doc_type":"api",
 		"kw":"Querying a Specified Backup,Backups,API Reference",
 		"search_title":"",

docs/cbr/api-ref/CLASS.TXT.json

@@ -234,7 +234,7 @@
 		"code":"26"
 	},
 	{
-		"desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.",
+		"desc":"This API is used to query all backups.If you want to create a backup, create a Restore Point.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes",
 		"product_code":"cbr",
 		"title":"Querying All Backups",
 		"uri":"ListBackups.html",
@@ -252,7 +252,7 @@
 		"code":"28"
 	},
 	{
-		"desc":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.",
+		"desc":"This API is used to query the backup of a specific ID.If you want to create a backup, create a Restore Point.GET /v3/{project_id}/backups/{backup_id}Status code: 200Statu",
 		"product_code":"cbr",
 		"title":"Querying a Specified Backup",
 		"uri":"ShowBackup.html",

docs/cbr/api-ref/ErrorCode.html

@@ -696,6 +696,17 @@
 <td class="cellrowborder" valign="top" width="25.66%" headers="mcps1.3.1.1.6.1.5 "><p id="ErrorCode__p894787125">Try again later.</p>
 </td>
 </tr>
+<tr id="ErrorCode__row1911104513484"><td class="cellrowborder" valign="top" width="10.9%" headers="mcps1.3.1.1.6.1.1 "><p id="ErrorCode__p76648015816">400</p>
+</td>
+<td class="cellrowborder" valign="top" width="19.34%" headers="mcps1.3.1.1.6.1.2 "><p id="ErrorCode__p1866412019583">BackupService.6220</p>
+</td>
+<td class="cellrowborder" valign="top" width="20.7%" headers="mcps1.3.1.1.6.1.3 "><p id="ErrorCode__p176649075818">Automatic backups in the locked repository are prohibited from being manually deleted.</p>
+</td>
+<td class="cellrowborder" valign="top" width="23.400000000000002%" headers="mcps1.3.1.1.6.1.4 "><p id="ErrorCode__p116643013587">Automatic backups in locked vaults cannot be manually deleted.</p>
+</td>
+<td class="cellrowborder" valign="top" width="25.66%" headers="mcps1.3.1.1.6.1.5 "><p id="ErrorCode__p7664180145815">Automatic backups in locked vaults cannot be manually deleted.</p>
+</td>
+</tr>
 <tr id="ErrorCode__row105431837151114"><td class="cellrowborder" valign="top" width="10.9%" headers="mcps1.3.1.1.6.1.1 "><p id="ErrorCode__p9942812126">400</p>
 </td>
 <td class="cellrowborder" valign="top" width="19.34%" headers="mcps1.3.1.1.6.1.2 "><p id="ErrorCode__p1941888127">BackupService.6300</p>

docs/cbr/api-ref/cbr_04_0025.html

@@ -8,10 +8,16 @@
 </th>
 </tr>
 </thead>
-<tbody><tr id="cbr_04_0025__row11729450163515"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p3730105013359">2025-03-27</p>
+<tbody><tr id="cbr_04_0025__row636983616188"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p143691736141813">2025-06-20</p>
+</td>
+<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.1.1.3.1.2 "><p id="cbr_04_0025__p836923631810">Updated the following content:</p>
+<ul id="cbr_04_0025__ul19082013131916"><li id="cbr_04_0025__li15908213151910">Added parameter descriptions.</li><li id="cbr_04_0025__li69081132197">Added an error code.</li></ul>
+</td>
+</tr>
+<tr id="cbr_04_0025__row11729450163515"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p3730105013359">2025-03-27</p>
 </td>
 <td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.1.1.3.1.2 "><p id="cbr_04_0025__p973011505352">Updated the following content:</p>
-<ul id="cbr_04_0025__ul154608508482"><li id="cbr_04_0025__li946015020482">Added the backup locking function and the <strong id="cbr_04_0025__b1923685244">locked</strong> field in sections "Creating a Vault", "Querying a Specified Vault", "Querying the Vault List", "Modifying a Vault", and "Querying the Vault Resources."</li><li id="cbr_04_0025__li1138115718481">Optimized some parameter descriptions.</li></ul>
+<ul id="cbr_04_0025__ul154608508482"><li id="cbr_04_0025__li946015020482">Added the backup locking function and the <strong id="cbr_04_0025__b1328864816">locked</strong> field in sections "Creating a Vault", "Querying a Specified Vault", "Querying the Vault List", "Modifying a Vault", and "Querying the Vault Resources."</li><li id="cbr_04_0025__li1138115718481">Optimized some parameter descriptions.</li></ul>
 </td>
 </tr>
 <tr id="cbr_04_0025__row112844326361"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p528415328364">2024-09-09</p>

docs/cbr/umn/cbr_01_0035.html

@@ -1,7 +1,7 @@
 <a name="cbr_01_0035"></a><a name="cbr_01_0035"></a>
 
 <h1 class="topictitle1">Enabling Backup Locking</h1>
-<div id="body0000001769971034"><div class="section" id="cbr_01_0035__section1280903264213"><h4 class="sectiontitle">Scenarios</h4><p id="cbr_01_0035__p4440105814416">To prevent the backup data from being deleted by mistake or maliciously, you can enable backup locking for vaults to improve data security (eu-nl).</p>
+<div id="body0000001769971034"><div class="section" id="cbr_01_0035__section1280903264213"><h4 class="sectiontitle">Scenarios</h4><p id="cbr_01_0035__p4440105814416">To prevent the backup data from being deleted by mistake or maliciously, you can enable backup locking for vaults to improve data security.</p>
 <p id="cbr_01_0035__p5959711437">Once enabled, all backups in the vault enter the WORM (write once, read many) status. No one can delete the backups that are in their retention periods.</p>
 <p id="cbr_01_0035__p9523102465818">This section describes how to enable backup locking for a vault. You can also enable it when creating a vault.</p>
 <div class="note" id="cbr_01_0035__note1362612872516"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="cbr_01_0035__ul13482125912515"><li id="cbr_01_0035__li7482959192520">Backup locking does not affect normal backup, restoration, and replication operations.</li><li id="cbr_01_0035__li114821593252">Manual backups are not affected by backup locking and can be manually deleted.</li></ul>

docs/cbr/umn/cbr_02_0003.html

@@ -5,7 +5,7 @@
 <div class="section" id="cbr_02_0003__section164547854318"><h4 class="sectiontitle">Procedure</h4><ol id="cbr_02_0003__ol172991625174013"><li id="cbr_02_0003__li21012745223034"><span>Log in to the CBR console.</span><p><ol type="a" id="cbr_02_0003__ol6567385123151"><li id="cbr_02_0003__li5480597823151">Log in to the management console.</li><li id="cbr_02_0003__li69106284253">Click <span><img id="cbr_02_0003__image1844744225011" src="en-us_image_0159365094.png"></span> in the upper left corner and select a region.</li><li id="cbr_02_0003__li4225424523410">Click <span><img id="cbr_02_0003__image8512125016910" src="en-us_image_0000001599534545.jpg"></span> and choose <strong id="cbr_02_0003__b124374110337">Storage</strong> &gt; <strong id="cbr_02_0003__b164372112331">Cloud Backup and Recovery</strong>. Select a backup type from the left navigation pane.</li></ol>
 </p></li><li id="cbr_02_0003__li58145134108"><span>In the upper right corner of the page, click <span class="uicontrol" id="cbr_02_0003__uicontrol169271845153211"><b>Create Server Backup Vault</b></span>.</span></li><li id="cbr_02_0003__li655775585717"><span>Select a protection type.</span><p><ul id="cbr_02_0003__ul2721149131314"><li id="cbr_02_0003__li974349101319"><strong id="cbr_02_0003__b113122284588">Backup</strong>: A server backup vault stores server backups.</li><li id="cbr_02_0003__li1325817661417"><strong id="cbr_02_0003__b5163111365910">Replication</strong>: A server replication vault stores replicas of server backups. If you select <strong id="cbr_02_0003__b109941211702">Replication</strong>, you do not need to select a server.</li></ul>
 <p id="cbr_02_0003__p1672520238431">For example, if you want to back up a server, select <strong id="cbr_02_0003__b95941948162119">Backup</strong> for the vault protection type. If you want to replicate backups of a server from one region to another, select <strong id="cbr_02_0003__b13347124113221">Replication</strong> for the vault in this other region.</p>
-</p></li><li id="cbr_02_0003__li1855113393127"><span>Determine whether to enable backup locking (eu-nl).</span><p><p id="cbr_02_0003__p18481241121212">If enabled, backups in the vault will not be deleted maliciously or by mistake, improving data reliability.</p>
+</p></li><li id="cbr_02_0003__li1855113393127"><span>Determine whether to enable backup locking.</span><p><p id="cbr_02_0003__p18481241121212">If enabled, backups in the vault will not be deleted maliciously or by mistake, improving data reliability.</p>
 <p id="cbr_02_0003__p71058510587"><span><img id="cbr_02_0003__image158772511584" src="en-us_image_0000002118794904.png" title="Click to enlarge" class="imgResize"></span></p>
 <div class="notice" id="cbr_02_0003__note5618144881311"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="cbr_02_0003__p116181248121316">Backup locking cannot be disabled after it is enabled.</p>
 </div></div>

docs/cbr/umn/cbr_02_0004.html

@@ -3,7 +3,7 @@
 <h1 class="topictitle1">Creating a Disk Backup Vault</h1>
 <div id="body1551322014755"><p id="cbr_02_0004__p331959184113">This section describes how to create a disk backup vault.</p>
 <div class="section" id="cbr_02_0004__section144674215197"><h4 class="sectiontitle">Procedure</h4><ol id="cbr_02_0004__ol172991625174013"><li id="cbr_02_0004__li21012745223034"><span>Log in to the CBR console.</span><p><ol type="a" id="cbr_02_0004__cbr_02_0003_ol6567385123151"><li id="cbr_02_0004__cbr_02_0003_li5480597823151">Log in to the management console.</li><li id="cbr_02_0004__cbr_02_0003_li69106284253">Click <span><img id="cbr_02_0004__cbr_02_0003_image1844744225011" src="en-us_image_0159365094.png"></span> in the upper left corner and select a region.</li><li id="cbr_02_0004__cbr_02_0003_li4225424523410">Click <span><img id="cbr_02_0004__cbr_02_0003_image8512125016910" src="en-us_image_0000001599534545.jpg"></span> and choose <strong id="cbr_02_0004__cbr_02_0003_b124374110337">Storage</strong> &gt; <strong id="cbr_02_0004__cbr_02_0003_b164372112331">Cloud Backup and Recovery</strong>. Select a backup type from the left navigation pane.</li></ol>
-</p></li><li id="cbr_02_0004__li58145134108"><span>In the upper right corner of the page, click <span class="uicontrol" id="cbr_02_0004__uicontrol12363182315817"><b>Create Disk Backup Vault</b></span>.</span></li><li id="cbr_02_0004__li46327183142"><span>Determine whether to enable backup locking (eu-nl).</span><p><p id="cbr_02_0004__cbr_02_0003_p18481241121212">If backup locking is enabled, backups in the vault will not be deleted maliciously or by mistake. This improves data reliability.</p>
+</p></li><li id="cbr_02_0004__li58145134108"><span>In the upper right corner of the page, click <span class="uicontrol" id="cbr_02_0004__uicontrol12363182315817"><b>Create Disk Backup Vault</b></span>.</span></li><li id="cbr_02_0004__li46327183142"><span>Determine whether to enable backup locking.</span><p><p id="cbr_02_0004__cbr_02_0003_p18481241121212">If backup locking is enabled, backups in the vault will not be deleted maliciously or by mistake. This improves data reliability.</p>
 <p id="cbr_02_0004__cbr_02_0003_p71058510587"><span><img id="cbr_02_0004__cbr_02_0003_image158772511584" src="en-us_image_0000002124587690.png" title="Click to enlarge" class="imgResize"></span></p>
 <div class="notice" id="cbr_02_0004__cbr_02_0003_note5618144881311"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="cbr_02_0004__cbr_02_0003_p116181248121316">Backup locking cannot be disabled after it is enabled.</p>
 </div></div>

docs/cbr/umn/cbr_02_0010.html

@@ -4,7 +4,7 @@
 <div id="body1578968755986"><p id="cbr_02_0010__p331959184113">This section describes how to create an SFS Turbo backup vault.</p>
 <div class="section" id="cbr_02_0010__section144674215197"><h4 class="sectiontitle">Procedure</h4><ol id="cbr_02_0010__ol172991625174013"><li id="cbr_02_0010__li21012745223034"><span>Log in to the CBR console.</span><p><ol type="a" id="cbr_02_0010__ol6567385123151"><li id="cbr_02_0010__li5480597823151">Log in to the management console.</li><li id="cbr_02_0010__li984641874716">Click <span><img id="cbr_02_0010__image1844744225011" src="en-us_image_0000001587692708.png"></span> in the upper left corner and select a region.</li><li id="cbr_02_0010__li4225424523410">Click <span><img id="cbr_02_0010__image8512125016910" src="en-us_image_0000001599596653.jpg"></span> and choose <strong id="cbr_02_0010__b91951628114518">Storage</strong> &gt; <strong id="cbr_02_0010__b182301831114515">Cloud Backup and Recovery</strong> &gt; <strong id="cbr_02_0010__b5202834194510">SFS Turbo Backups</strong>.</li></ol>
 </p></li><li id="cbr_02_0010__li58145134108"><span>In the upper right corner of the page, click <span class="uicontrol" id="cbr_02_0010__uicontrol118981120815"><b>Create SFS Turbo Backup Vault</b></span>.</span></li><li id="cbr_02_0010__li655775585717"><span>Select a protection type.</span><p><ul id="cbr_02_0010__ul2721149131314"><li id="cbr_02_0010__li974349101319"><strong id="cbr_02_0010__b1455145517537">Backup</strong>: An SFS Turbo backup vault stores SFS Turbo backups.</li></ul>
-</p></li><li id="cbr_02_0010__li46327183142"><span>Determine whether to enable backup locking (eu-nl).</span><p><p id="cbr_02_0010__cbr_02_0003_p18481241121212">If backup locking is enabled, backups in the vault will not be deleted maliciously or by mistake. This improves data reliability.</p>
+</p></li><li id="cbr_02_0010__li46327183142"><span>Determine whether to enable backup locking.</span><p><p id="cbr_02_0010__cbr_02_0003_p18481241121212">If backup locking is enabled, backups in the vault will not be deleted maliciously or by mistake. This improves data reliability.</p>
 <p id="cbr_02_0010__cbr_02_0003_p71058510587"><span><img id="cbr_02_0010__cbr_02_0003_image158772511584" src="en-us_image_0000002159985785.png" title="Click to enlarge" class="imgResize"></span></p>
 <div class="notice" id="cbr_02_0010__cbr_02_0003_note5618144881311"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="cbr_02_0010__cbr_02_0003_p116181248121316">Backup locking cannot be disabled after it is enabled.</p>
 </div></div>

docs/cbr/umn/cbr_03_0160.html

@@ -8,7 +8,14 @@
 </th>
 </tr>
 </thead>
-<tbody><tr id="cbr_03_0160__row1698171615212"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_03_0160__p9982111612211">2025-05-27</p>
+<tbody><tr id="cbr_03_0160__row1032413314463"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_03_0160__p14325193114615">2025-06-22</p>
+</td>
+<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.1.1.3.1.2 "><p id="cbr_03_0160__p2437161115462">This is the thirty-first official release.</p>
+<p id="cbr_03_0160__p1043761164610">Updated the following content:</p>
+<p id="cbr_03_0160__p132519310469">Modified the descriptions in section "Why Is My Backup Size Larger Than My Disk Size?"</p>
+</td>
+</tr>
+<tr id="cbr_03_0160__row1698171615212"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_03_0160__p9982111612211">2025-05-27</p>
 </td>
 <td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.1.1.3.1.2 "><p id="cbr_03_0160__p9159112792112">This issue is the thirtieth official release.</p>
 <p id="cbr_03_0160__p915911272214">Updated the following content:</p>

docs/cbr/umn/cbr_06_00110.html

@@ -5,7 +5,7 @@
 </li><li id="cbr_06_00110__en-us_topic_0178706774_li27870317308">The ECS backup size is larger than the used disk space obtained from the file system.</li></ul>
 </div>
 <div class="section" id="cbr_06_00110__en-us_topic_0178706774_section557334373015"><h4 class="sectiontitle">Possible Causes</h4><p id="cbr_06_00110__en-us_topic_0178706774_p46077404118">Possible causes are as follows:</p>
-<ul id="cbr_06_00110__en-us_topic_0178706774_ul1799673210417"><li id="cbr_06_00110__en-us_topic_0178706774_li156916351510">The backup mechanism itself causes this problem. The cloud server backups, SFS Turbo backups, and cloud disk backups created using CBR are all <strong id="cbr_06_00110__en-us_topic_0178706774_b72181831194112">block-level backups</strong>. Different from file-level backups, block-level backups are performed by sector (512 bytes) each time.</li><li id="cbr_06_00110__en-us_topic_0178706774_li149961032154110">The metadata of the file systems on the disk occupies disk space.</li><li id="cbr_06_00110__en-us_topic_0178706774_li1597711341628">To reduce performance overhead, the file system adds a delete marker for the deleted file, but does not erase the data that has been written to the sector, and the metadata on the sector still exists. Block-level backups cannot detect whether data on a sector is deleted or not, but only determine whether a backup needs to be performed by checking whether all data blocks are zero blocks.</li><li id="cbr_06_00110__en-us_topic_0178706774_li1117971782619">CBR determines whether data in each sector changes by comparing two snapshots. Data changes include data addition, modification, and deletion. Backup is not performed if there are no data changes. If there are data changes, CBR further checks whether data blocks in the sector are all zero blocks. If so, backup is also not performed. Backups are performed only when there are non-zero blocks. If the data is deleted but metadata in the sector is not, the data block is also recognized as a non-zero block, and backups will be performed.</li></ul>
+<ul id="cbr_06_00110__en-us_topic_0178706774_ul1799673210417"><li id="cbr_06_00110__en-us_topic_0178706774_li156916351510">The backup mechanism itself causes this problem. The cloud server backups, SFS Turbo backups, and cloud disk backups created using CBR are all <strong id="cbr_06_00110__en-us_topic_0178706774_b72181831194112">block-level backups</strong>. Different from file-level backups, block-level backups are performed by sector (512 bytes) each time.</li><li id="cbr_06_00110__en-us_topic_0178706774_li149961032154110">The metadata of the file systems on the disk occupies disk space.</li><li id="cbr_06_00110__en-us_topic_0178706774_li1597711341628">To reduce performance overhead, the file system adds a delete marker for the deleted file, but does not erase the data that has been written to the sector, and the metadata on the sector still exists. Block-level backups cannot detect whether data on a sector is deleted or not, but only determine whether a backup needs to be performed by checking whether all data blocks are zero blocks.</li><li id="cbr_06_00110__en-us_topic_0178706774_li1117971782619">CBR determines whether data in each sector changes by comparing two snapshots. Data changes include data addition, modification, and deletion. If there are data changes, CBR further checks whether data blocks in the sector are all zero blocks. If so, the data blocks will not be backed up and will not be counted in the new backup capacity. If there are non-zero blocks, they will be backed up and will be counted in the new backup capacity. If the data is deleted but metadata in the sector is not, the data block is also recognized as a non-zero block, and backups will be performed.</li></ul>
 </div>
 </div>
 <div>

docs/css/umn/css_01_0009.html

@@ -0,0 +1,37 @@
+<a name="css_01_0009"></a><a name="css_01_0009"></a>
+
+<h1 class="topictitle1">Managing Elasticsearch Clusters</h1>
+<div id="body1503460464688"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0415.html">Viewing Elasticsearch Cluster Information</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0417.html">Creating Users for an Elasticsearch Cluster and Granting Cluster Access</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0075.html">Setting Tags for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0080.html">Configuring Default Parameters in the .yml Configuration File of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0058.html">Binding an Elasticsearch Cluster to an Enterprise Project</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0418.html">Changing the Node Specifications of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0156.html">Replacing Specified Nodes for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0158.html">Changing the Security Mode of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0201.html">Switching AZs for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0060.html">Managing Failed Tasks for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0014.html">Restarting an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0015.html">Deleting an Elasticsearch Cluster</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0014.html

@@ -0,0 +1,80 @@
+<a name="css_01_0014"></a><a name="css_01_0014"></a>
+
+<h1 class="topictitle1">Restarting an Elasticsearch Cluster</h1>
+<div id="body1503460464688"><p id="css_01_0014__en-us_topic_0000001223594400_p16296586613">If an Elasticsearch cluster has stopped working, you can try to recover it by restarting it. Two restart options are available: quick restart and rolling restart. You are advised to perform the restart during off-peak hours.</p>
+<div class="section" id="css_01_0014__section1838035769"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0014__ul14426204917714"><li id="css_01_0014__li1842618498719">Avoid restarting a cluster during peak hours, as doing so may impact data integrity and service availability.</li><li id="css_01_0014__li343322916811">During a quick restart, the cluster is unavailable for the entire duration of the restart.</li><li id="css_01_0014__li484614381083">Rolling restart is supported only for clusters with three or more nodes, including the master node, client node, and cold data nodes. During a rolling restart, only the nodes that are being restarted are unavailable. When the cluster stores a large amount of data, the restart may take a long time.</li></ul>
+</div>
+<div class="section" id="css_01_0014__en-us_topic_0000001223594400_section5511250184611"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0014__en-us_topic_0000001223594400_ul1188663672716"><li id="css_01_0014__en-us_topic_0000001223594400_li158861636162718">The cluster you want to restart is not frozen and has no task in progress.</li><li id="css_01_0014__en-us_topic_0000001223594400_li19886193642716">The cluster is available and is not processing any service requests, such as importing and searching for data. Otherwise, data loss may occur during a cluster restart.</li></ul>
+</div>
+<div class="section" id="css_01_0014__en-us_topic_0000001223594400_section144817324321"><h4 class="sectiontitle">Quick Restart</h4><ol id="css_01_0014__en-us_topic_0000001223594400_ol59716110339"><li id="css_01_0014__en-us_topic_0000001223594400_li93271911152510">Log in to the <span id="css_01_0014__text831239281111613">CSS</span> management console.</li><li id="css_01_0014__li18952123014383">In the navigation pane on the left, expand <strong id="css_01_0014__b1162093215217">Clusters</strong> and select a cluster type. A cluster list is displayed.</li><li id="css_01_0014__en-us_topic_0000001223594400_li163277114258">Locate the target cluster and click <strong id="css_01_0014__b249272313226">More</strong> &gt; <strong id="css_01_0014__b17493132322217">Restart</strong> in the <strong id="css_01_0014__b17493102312219">Operation</strong> column.</li><li id="css_01_0014__en-us_topic_0000001223594400_li2820155185915">On the <strong id="css_01_0014__b123844719229">Restart Cluster</strong> page, set parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0014__table99255327161" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Configuring a quick restart</caption><thead align="left"><tr id="css_01_0014__row129252325165"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.2.4.2.2.3.1.1"><p id="css_01_0014__p18925143231613">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_0014__p1792533216161">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0014__row1092503218166"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0014__p1692513219164">Restart Mode</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0014__p15925132131611">Select <strong id="css_01_0014__b7505115392315">Quick Restart</strong>.</p>
+<div class="note" id="css_01_0014__note6933516161810"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0014__p16933131617188">The cluster will be unavailable for the entire duration of a quick restart.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0014__row2925132201619"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0014__p16925103216169">Operation Role</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0014__p3925732101619">Select <strong id="css_01_0014__b256117594492">Node type</strong> or <strong id="css_01_0014__b144373563495">Node name</strong>.</p>
+<ul id="css_01_0014__ul1129517818203"><li id="css_01_0014__li32951786203"><strong id="css_01_0014__b5449230155010">Node type</strong>: You can select multiple node types to restart them at the same time.</li><li id="css_01_0014__li1229510811209"><strong id="css_01_0014__b135142056135012">Node name</strong>: You can restart only one node at a time.</li></ul>
+</td>
+</tr>
+<tr id="css_01_0014__row15925193211620"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0014__p59251932191614">Operation Value</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0014__p392573218161">Select one or more node types or a node name, depending on the setting of <strong id="css_01_0014__b1481054155717">Operation Role</strong>.</p>
+<p id="css_01_0014__p15771142052317">Values for <strong id="css_01_0014__b723511313214">Node type</strong>:</p>
+<ul id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_ul12497123683"><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li64981323284"><strong id="css_01_0014__b31982840711534">ess</strong>: data node</li><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li6498112311818"><strong id="css_01_0014__b50414626311534">ess-master</strong>: master node</li><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li114982231584"><strong id="css_01_0014__b95168469611534">ess-client</strong>: client node</li><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li64984238813"><strong id="css_01_0014__b172546262911534">ess-cold</strong>: cold data node</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li><li id="css_01_0014__li198531756182412">Click OK to start the restart task.<p id="css_01_0014__p6463155732410"><a name="css_01_0014__li198531756182412"></a><a name="li198531756182412"></a>Refresh the page and check the cluster status. During the restart, the cluster status is <span class="parmvalue" id="css_01_0014__parmvalue21998578011534"><b><span id="css_01_0014__text196523526011534">Processing</span></b></span>, and the task status is <span class="parmvalue" id="css_01_0014__parmvalue213227894811534"><b>Restarting</b></span>. When the cluster status changes to <strong id="css_01_0014__b1130313613316">Available</strong>, the cluster has restarted successfully.</p>
+</li></ol>
+</div>
+<div class="section" id="css_01_0014__en-us_topic_0000001223594400_section1533564513219"><h4 class="sectiontitle">Rolling Restart</h4><ol id="css_01_0014__en-us_topic_0000001223594400_ol14670132413362"><li id="css_01_0014__en-us_topic_0000001223594400_li176702024193612">Log in to the <span id="css_01_0014__text1903035677111613">CSS</span> management console.</li><li id="css_01_0014__li1551955943712">In the navigation pane on the left, expand <strong id="css_01_0014__b6754152411313">Clusters</strong> and select a cluster type. A cluster list is displayed.</li><li id="css_01_0014__en-us_topic_0000001223594400_li1067012453614">Locate the target cluster and click <strong id="css_01_0014__b1599729437">More</strong> &gt; <strong id="css_01_0014__b115997293316">Restart</strong> in the <strong id="css_01_0014__b1459962915318">Operation</strong> column.</li><li id="css_01_0014__en-us_topic_0000001223594400_li39318693">On the <strong id="css_01_0014__b9512133412315">Restart Cluster</strong> page, set parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0014__table17811171742817" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Configuring a rolling restart</caption><thead align="left"><tr id="css_01_0014__row1181131718286"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.4.2.2.3.1.1"><p id="css_01_0014__p1781116176289">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_0014__p15811217152814">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0014__row1381120174286"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0014__p381111179281">Restart Mode</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0014__p198113174287">Select <strong id="css_01_0014__b064301214416">Rolling Restart</strong>.</p>
+<div class="note" id="css_01_0014__note148111217142817"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="css_01_0014__ul119432033173118"><li id="css_01_0014__li14943143313118">Rolling restart is supported only for clusters with three or more nodes, including the master node, client node, and cold data nodes.</li><li id="css_01_0014__li199431433193112">During a rolling restart, the nodes of a cluster are restarted one at time. This may take a long time if the cluster has a large number of indexes.</li></ul>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0014__row28112017182813"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0014__p12812111772813">Operation Role</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0014__p0812017132817">Only <strong id="css_01_0014__b250952911149">Node type</strong> is supported. You can select multiple node types to restart them at the same time.</p>
+</td>
+</tr>
+<tr id="css_01_0014__row168127175289"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0014__p68121317102817">Operation Value</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0014__p19812417102814">Select node types for the restart.</p>
+<p id="css_01_0014__p20812317162816">Values for <strong id="css_01_0014__b15382123810154">Node type</strong>:</p>
+<ul id="css_01_0014__ul381271718280"><li id="css_01_0014__li0812101714287"><strong id="css_01_0014__b17820184014158">ess</strong>: data node</li><li id="css_01_0014__li1481215173282"><strong id="css_01_0014__b660944310151">ess-master</strong>: master node</li><li id="css_01_0014__li1181241711281"><strong id="css_01_0014__b78521225111534">ess-client</strong>: client node</li><li id="css_01_0014__li481220178283"><strong id="css_01_0014__b40279453911534">ess-cold</strong>: cold data node</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li><li id="css_01_0014__li2037573512356">Click OK to start the restart task.<p id="css_01_0014__p18375535133519"><a name="css_01_0014__li2037573512356"></a><a name="li2037573512356"></a>Refresh the page and check the cluster status. During the restart, the cluster status is <span class="parmvalue" id="css_01_0014__parmvalue38659524152"><b><span id="css_01_0014__text12864135217154">Processing</span></b></span>, and the task status is <span class="parmvalue" id="css_01_0014__parmvalue1086575218152"><b>Restarting</b></span>. When the cluster status changes to <strong id="css_01_0014__b867125631516">Available</strong>, the cluster has restarted successfully.</p>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0015.html

@@ -0,0 +1,15 @@
+<a name="css_01_0015"></a><a name="css_01_0015"></a>
+
+<h1 class="topictitle1">Deleting an Elasticsearch Cluster</h1>
+<div id="body1503460464688"><p id="css_01_0015__en-us_topic_0000001268594553_p1219762501">You can delete clusters that you no longer need.</p>
+<div class="section" id="css_01_0015__section6834143742917"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0015__en-us_topic_0000001268594553_ul3613184185219"><li id="css_01_0015__en-us_topic_0000001268594553_li1461319413523">Deleting a cluster will clear all its data. Exercise caution.</li><li id="css_01_0015__en-us_topic_0000001268594553_li1980118281592">A cluster that has no snapshots created for it cannot be restored once it is deleted. The snapshots of the cluster stored in OBS, if any, will not be deleted with the cluster. You can restore a deleted cluster using its snapshots stored in the OBS bucket.</li><li id="css_01_0015__li9728758142317">For a cluster for which the VPCEP service has been enabled, deleting the cluster may not delete the VPC endpoint associated with the cluster if the current account does not have the necessary VPCEP permissions. For details about the VPCEP permissions, see section "Permissions" in <em id="css_01_0015__i64101029124318">VPC Endpoint User Guide</em>.</li></ul>
+</div>
+<div class="section" id="css_01_0015__en-us_topic_0000001268594553_section175418313575"><h4 class="sectiontitle">Deleting a Cluster</h4><ol id="css_01_0015__en-us_topic_0000001268594553_ol20161122142614"><li id="css_01_0015__en-us_topic_0000001268594553_li11622242616">Log in to the <span id="css_01_0015__text68166500111614">CSS</span> management console.</li><li id="css_01_0015__en-us_topic_0000001268594553_li1180413314595">In the navigation tree on the left, select a cluster type. The cluster list page is displayed.</li><li id="css_01_0015__en-us_topic_0000001268594553_li9160224260">Locate the target cluster and click <strong id="css_01_0015__en-us_topic_0000001268594553_b3863134022819">More</strong> &gt; <strong id="css_01_0015__en-us_topic_0000001268594553_b4464114252818">Delete</strong> in the <strong id="css_01_0015__en-us_topic_0000001268594553_b1698111072819">Operation</strong> column.</li><li id="css_01_0015__en-us_topic_0000001268594553_li21622222619">In the displayed dialog box, manually type in <strong id="css_01_0015__b12173151714287">DELETE</strong>, and click <span class="uicontrol" id="css_01_0015__uicontrol3955167898125"><b>OK</b></span>.</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0045.html

@@ -0,0 +1,23 @@
+<a name="css_01_0045"></a><a name="css_01_0045"></a>
+
+<h1 class="topictitle1">Importing Data to an Elasticsearch Cluster</h1>
+<div id="body1504584479327"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0394.html">Different Ways to Import Data to an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0048.html">Using In-house Built Logstash to Import Data to Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0024.html">Using Open Source Elasticsearch APIs to Import Data to Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0396.html">Using CDM to Import Data to Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0397.html">Enhancing the Data Import Performance of Elasticsearch Clusters</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0058.html

@@ -0,0 +1,18 @@
+<a name="css_01_0058"></a><a name="css_01_0058"></a>
+
+<h1 class="topictitle1">Binding an Elasticsearch Cluster to an Enterprise Project</h1>
+<div id="body1547448423138"><p id="css_01_0058__en-us_topic_0000001268594561_p17448200144115">You can create enterprise projects based on your organizational structure. Then you can manage resources across different regions by enterprise project, add users and user groups to enterprise projects, and grant different permissions to the users and user groups. This section describes how to bind a CSS cluster to an enterprise project and how to modify an enterprise project.</p>
+<div class="section" id="css_01_0058__en-us_topic_0000001268594561_section149801923192910"><h4 class="sectiontitle">Prerequisites</h4><p id="css_01_0058__en-us_topic_0000001268594561_p166501928172918">Before binding an enterprise project, you have created an enterprise project.</p>
+</div>
+<div class="section" id="css_01_0058__en-us_topic_0000001268594561_section57873201918"><h4 class="sectiontitle">Binding an Enterprise Project</h4><p id="css_01_0058__en-us_topic_0000001268594561_p2210251391">When creating a cluster, you can bind an existing enterprise project to the cluster, or click <strong id="css_01_0058__b359216131512">View Enterprise Project</strong> to go to the enterprise project management console and create a new project or view existing projects.</p>
+</div>
+<div class="section" id="css_01_0058__en-us_topic_0000001268594561_section2120201511011"><h4 class="sectiontitle">Modifying an Enterprise Project</h4><p id="css_01_0058__en-us_topic_0000001268594561_p7438234131011">For a cluster that has been created, you can modify its enterprise project based on the site requirements.</p>
+<ol id="css_01_0058__en-us_topic_0000001268594561_ol1947141411194"><li id="css_01_0058__en-us_topic_0000001268594561_li8101103316318">Log in to the CSS management console.</li><li id="css_01_0058__en-us_topic_0000001268594561_li6302956053">In the navigation pane on the left, select a cluster type. The cluster management page is displayed.</li><li id="css_01_0058__en-us_topic_0000001268594561_li8302155619516">In the cluster list on the displayed page, click the target cluster name to switch to the <strong id="css_01_0058__en-us_topic_0000001268594561_b655595516369">Cluster Information</strong> page.</li><li id="css_01_0058__en-us_topic_0000001268594561_li4230112181920">On the <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol1144519117472"><b>Cluster Information</b></span> page, click the enterprise project name on the right of <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol12693632149"><b>Enterprise Project</b></span>. The project management page is displayed.</li><li id="css_01_0058__en-us_topic_0000001268594561_li1669213196206">On the <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol4510247182817"><b>Resources</b></span> tab page, select the region of the current cluster, and select <strong id="css_01_0058__b988412014713">CSS</strong> for <strong id="css_01_0058__b75453276475">Service</strong>. In this case, the corresponding CSS cluster is displayed in the resource list.</li><li id="css_01_0058__en-us_topic_0000001268594561_li78671469217">Select the cluster whose enterprise project you want to modify and click <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol5366101511813"><b>Remove</b></span>.</li><li id="css_01_0058__en-us_topic_0000001268594561_li19166117162317">On the <span class="wintitle" id="css_01_0058__en-us_topic_0000001268594561_wintitle1516933271819"><b>Remove Resource</b></span> page, specify <span class="parmname" id="css_01_0058__en-us_topic_0000001268594561_parmname1674851311229"><b>Mode</b></span> and select <span class="parmname" id="css_01_0058__en-us_topic_0000001268594561_parmname1365814264018"><b>Destination Enterprise Project</b></span>, and click <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol199034303020"><b>OK</b></span>.</li><li id="css_01_0058__en-us_topic_0000001268594561_li599664183618">After the resource is removed, you can view the modified enterprise project information on the <strong id="css_01_0058__en-us_topic_0000001268594561_b119217384210">Clusters</strong> page.</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0060.html

@@ -0,0 +1,88 @@
+<a name="css_01_0060"></a><a name="css_01_0060"></a>
+
+<h1 class="topictitle1">Managing Failed Tasks for Elasticsearch Clusters</h1>
+<div id="body1551949933089"><p id="css_01_0060__en-us_topic_0000001268594529_p8060118">In the <strong id="css_01_0060__en-us_topic_0000001268594529_b17876132011117">Failed Tasks</strong> dialog box, you can view the failed tasks related to a cluster, such as failing to create, restart, scale out, back up, or restore a cluster. In addition, you can view the failure cause of each task and choose to delete one or all failed tasks.</p>
+<div class="section" id="css_01_0060__en-us_topic_0000001268594529_section1393913131117"><h4 class="sectiontitle">Viewing Failed Tasks</h4><ol id="css_01_0060__en-us_topic_0000001268594529_ol47861611101112"><li id="css_01_0060__en-us_topic_0000001268594529_li11622242616">Log in to the <span id="css_01_0060__text219732339111612">CSS</span> management console.</li><li id="css_01_0060__en-us_topic_0000001268594529_li9160224260">Click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol181612228265"><b>Clusters</b></span> to switch to the <strong id="css_01_0060__en-us_topic_0000001268594529_b1867018334565">Clusters</strong> page. Click the digit next to <strong id="css_01_0060__en-us_topic_0000001268594529_b3305185125714">Failed Tasks</strong> to switch to the <strong id="css_01_0060__en-us_topic_0000001268594529_b143225195814">Failed Tasks</strong> dialog box.<div class="fignone" id="css_01_0060__en-us_topic_0000001268594529_fig9871436121212"><span class="figcap"><b>Figure 1 </b>Clicking the digit next to Failed Tasks</span><br><span><img id="css_01_0060__en-us_topic_0000001268594529_image273203201211" src="en-us_image_0000001938218564.png"></span></div>
+</li><li id="css_01_0060__en-us_topic_0000001268594529_li20774101315127">In the <span class="wintitle" id="css_01_0060__en-us_topic_0000001268594529_wintitle1966611331973"><b>Failed Tasks</b></span> dialog box, view all failed tasks of the current account. The following information about the failed tasks is displayed: <span class="parmname" id="css_01_0060__en-us_topic_0000001268594529_parmname731134883416"><b>Name/ID</b></span>, <span class="parmname" id="css_01_0060__en-us_topic_0000001268594529_parmname186392053143412"><b>Task Status</b></span>, and <span class="parmname" id="css_01_0060__en-us_topic_0000001268594529_parmname9729165663420"><b>Failure Time</b></span>.</li><li id="css_01_0060__en-us_topic_0000001268594529_li1372895910228">Click the question mark in the <strong id="css_01_0060__en-us_topic_0000001268594529_b09881747205910">Task Status</strong> column to view the failure cause of a task. You are advised to troubleshoot faults based on failure causes. For details about failure causes, see <a href="#css_01_0060__en-us_topic_0000001268594529_section155001521193312">Error Code</a>.<div class="fignone" id="css_01_0060__en-us_topic_0000001268594529_fig85418382253"><span class="figcap"><b>Figure 2 </b>Viewing the failure cause of a task</span><br><span><img id="css_01_0060__en-us_topic_0000001268594529_image1590019713599" src="en-us_image_0000001965416917.png"></span></div>
+</li></ol>
+</div>
+<div class="section" id="css_01_0060__en-us_topic_0000001268594529_section82881811133120"><h4 class="sectiontitle">Deleting a Failed Task</h4><p id="css_01_0060__en-us_topic_0000001268594529_p28053248314">You can delete one or all failed tasks at a time.</p>
+<ul id="css_01_0060__en-us_topic_0000001268594529_ul432662312313"><li id="css_01_0060__en-us_topic_0000001268594529_li15326723173111">To delete a failed task, perform the following operations: Locate the row that contains the target task and click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol148121620193317"><b>Delete</b></span> in the <strong id="css_01_0060__en-us_topic_0000001268594529_b191281311428">Operation</strong> column. In the displayed dialog box, confirm the task you want to delete and click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol1933113257334"><b>Yes</b></span>.</li><li id="css_01_0060__en-us_topic_0000001268594529_li33151127173319">To delete all failed tasks, perform the following operations: In the <span class="wintitle" id="css_01_0060__en-us_topic_0000001268594529_wintitle4538332105018"><b>Failed Tasks</b></span> dialog box, click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol323703312351"><b>Delete All</b></span>. In the displayed dialog box, confirm the information about all failed tasks and click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol18326203013516"><b>Yes</b></span>.</li></ul>
+<div class="fignone" id="css_01_0060__en-us_topic_0000001268594529_fig1419120710386"><span class="figcap"><b>Figure 3 </b>Deleting a failed task</span><br><span><img id="css_01_0060__en-us_topic_0000001268594529_image549413524592" src="en-us_image_0000001938377924.png"></span></div>
+</div>
+<div class="section" id="css_01_0060__en-us_topic_0000001268594529_section155001521193312"><a name="css_01_0060__en-us_topic_0000001268594529_section155001521193312"></a><a name="en-us_topic_0000001268594529_section155001521193312"></a><h4 class="sectiontitle">Error Code</h4>
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0060__en-us_topic_0000001268594529_table16751996354" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Failure causes</caption><thead align="left"><tr id="css_01_0060__en-us_topic_0000001268594529_row376129113519"><th align="left" class="cellrowborder" valign="top" width="14.111411141114111%" id="mcps1.3.4.2.2.4.1.1"><p id="css_01_0060__en-us_topic_0000001268594529_p19760913357">Error Code</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="55.23552355235524%" id="mcps1.3.4.2.2.4.1.2"><p id="css_01_0060__en-us_topic_0000001268594529_p147612903518">Failure Cause</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="30.653065306530653%" id="mcps1.3.4.2.2.4.1.3"><p id="css_01_0060__en-us_topic_0000001268594529_p14768953516">Solution</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0060__en-us_topic_0000001268594529_row6761895353"><td class="cellrowborder" valign="top" width="14.111411141114111%" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p776189183515">CSS.6000</p>
+</td>
+<td class="cellrowborder" valign="top" width="55.23552355235524%" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p187669193511">Failed to create the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+<td class="cellrowborder" rowspan="7" valign="top" width="30.653065306530653%" headers="mcps1.3.4.2.2.4.1.3 "><p id="css_01_0060__en-us_topic_0000001268594529_p1637191311276">Please try again later or contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row47649143514"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p1576697352">CSS.6001</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p77659123520">Failed to scale out the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row187619910350"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p16765915350">CSS.6002</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p187619903516">Failed to restart the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row14425154151017"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p242564121017">CSS.6003</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p7426104201017">Failed to restore the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row24264471015"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p194264418104">CSS.6004</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p242694121018">Failed to create the node because of ECS exceptions (<em id="css_01_0060__en-us_topic_0000001268594529_i62088384145">&lt;ECS error code&gt;</em>). Please try again later. If the problem persists, contact customer service.</p>
+<div class="note" id="css_01_0060__en-us_topic_0000001268594529_note07226420147"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0060__en-us_topic_0000001268594529_p1072324216145"><em id="css_01_0060__en-us_topic_0000001268594529_i1543285813142">&lt;ECS error code&gt;</em> indicates the error information reported by ECS. For details about the cause and solution, see <a href="https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0022067717.html" target="_blank" rel="noopener noreferrer">ECS Error Code Description</a>.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row144265410104"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p1942618413108">CSS.6005</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p154263461017">Failed to initialize the service because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row10480192161116"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p12480202121111">CSS.6007</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p4480102191117">Failed to create the snapshot because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row1448012191118"><td class="cellrowborder" valign="top" width="14.111411141114111%" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p124817211119">CSS.6008</p>
+</td>
+<td class="cellrowborder" valign="top" width="55.23552355235524%" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p8481421171113">Failed to create the snapshot because the OBS bucket you select does not exist or has been deleted.</p>
+</td>
+<td class="cellrowborder" rowspan="3" valign="top" width="30.653065306530653%" headers="mcps1.3.4.2.2.4.1.3 "><p id="css_01_0060__en-us_topic_0000001268594529_p2075718196277">Modify the OBS bucket.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row7481721141112"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p134819217111">CSS.6009</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p1148192161110">Failed to restore the snapshot because the OBS bucket you select does not exist or has been deleted.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row1770913013172"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p16709501175">CSS.6010</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p87094071710">Failed to restore the snapshot because the OBS object does not exist or has been deleted.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0070.html

@@ -0,0 +1,11 @@
+<a name="css_01_0070"></a><a name="css_01_0070"></a>
+
+<h1 class="topictitle1">CSS Service Permission Management</h1>
+<div id="body1558407759825"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0072.html">Creating IAM Users and Granting Them Permissions to Use CSS</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/css/umn/css_01_0072.html

@@ -0,0 +1,94 @@
+<a name="css_01_0072"></a><a name="css_01_0072"></a>
+
+<h1 class="topictitle1">Creating IAM Users and Granting Them Permissions to Use CSS</h1>
+<div id="body1558407759825"><p id="css_01_0072__p198079372297">You can use <a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0026.html" target="_blank" rel="noopener noreferrer">Identity and Access Management (IAM)</a> for fine-grained permissions control for CSS. With IAM, you can:</p>
+<ul id="css_01_0072__ul1848820457453"><li id="css_01_0072__li348974516454">Create IAM users for employees based on your enterprise's organizational structure. Each IAM user has their own identity credentials for accessing CSS resources.</li><li id="css_01_0072__li11681126173515">Grant users only the permissions required to perform a given task based on their job responsibilities.</li><li id="css_01_0072__li12185165313915">Entrust an account or a cloud service to perform efficient O&amp;M on your CSS resources.</li></ul>
+<p id="css_01_0072__p14662743155318">If your account does not require individual IAM users, you may skip this section.</p>
+<p id="css_01_0072__p158501603165">This section describes the procedure for granting permissions.</p>
+<div class="section" id="css_01_0072__en-us_topic_0000001223594424_section17110143884619"><h4 class="sectiontitle">Prerequisites</h4><p id="css_01_0072__en-us_topic_0000001223594424_p148607912478">You know what permissions to assign to which users. CSS supports administrator permissions and read-only permissions. For details, see Permissions Management.</p>
+</div>
+<div class="section" id="css_01_0072__en-us_topic_0000001223594424_section85262192392"><h4 class="sectiontitle">Process Flow</h4><div class="fignone" id="css_01_0072__en-us_topic_0000001223594424_fig342064620244"><span class="figcap"><b>Figure 1 </b>Process of granting CSS permissions</span><br><span><img id="css_01_0072__en-us_topic_0000001223594424_image237123492418" src="en-us_image_0000001938218776.png"></span></div>
+<ol id="css_01_0072__ol20958137181713"><li id="css_01_0072__li109582711173"><a name="css_01_0072__li109582711173"></a><a name="li109582711173"></a><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0030.html" target="_blank" rel="noopener noreferrer">Create a user group and assign permissions</a>.<p id="css_01_0072__en-us_topic_0000001223594424_p10577919163914">Create a user group on the IAM console, and assign the <strong id="css_01_0072__b1383745710419">CSS ReadOnlyAccess</strong> permission to the group.</p>
+</li><li id="css_01_0072__li29581574177"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0031.html" target="_blank" rel="noopener noreferrer">Create an IAM user and add it to a user group</a>.<p id="css_01_0072__en-us_topic_0000001223594424_p357781916392">Create a user on the IAM console and add it to the user group created in <a href="#css_01_0072__li109582711173">1</a>.</p>
+<p id="css_01_0072__p16681531173416">By adding a user to a user group, you assign all the permissions that this user group has to that user. All users in a group have the same permissions.</p>
+</li><li id="css_01_0072__li695812781716"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0032.html" target="_blank" rel="noopener noreferrer">Log in</a> and verify permissions.<p id="css_01_0072__en-us_topic_0000001223594424_p20577191943913">Log in to the console as the created user, switch to the authorized region, and verify the permissions.</p>
+<ul id="css_01_0072__en-us_topic_0000001489537442_ul1692751312242"><li id="css_01_0072__en-us_topic_0000001489537442_li205729227246">Choose <strong id="css_01_0072__b387918591516">Service List</strong> &gt; <strong id="css_01_0072__b68791551513">Cloud Search Service</strong>. Then click <strong id="css_01_0072__b1687914511151">Create Cluster</strong> on the CSS console. If the cluster cannot be purchased (assuming that the current permissions include only <strong id="css_01_0072__b98791558151">CSS ReadOnlyAccess</strong>), the <strong id="css_01_0072__b10879185131517">CSS ReadOnlyAccess</strong> policy has already taken effect.</li><li id="css_01_0072__en-us_topic_0000001489537442_li1857212212418">Choose any other service from <strong id="css_01_0072__b1943182197">Service List</strong>. (Assume that the current policy contains only <strong id="css_01_0072__b159443212920">CSS ReadOnlyAccess</strong>.) If a message appears indicating insufficient permissions to access the service, the <strong id="css_01_0072__b6944162995">CSS ReadOnlyAccess</strong> policy has already taken effect.</li></ul>
+</li></ol>
+</div>
+<div class="section" id="css_01_0072__section841205645419"><h4 class="sectiontitle">Examples of CSS Custom Policies</h4><p id="css_01_0072__en-us_topic_0000001223754348_p8060118">Custom policies can be created to supplement the system-defined policies of CSS. For the actions supported for custom policies, see section "Permissions Policies and Supported Actions" in the <em id="css_01_0072__i19933111411336">Cloud Search Service API Reference</em>.</p>
+<p id="css_01_0072__en-us_topic_0000001223754348_p18119246101411">You can create custom policies in either of the following ways:</p>
+<ul id="css_01_0072__en-us_topic_0000001223754348_ul611914619143"><li id="css_01_0072__en-us_topic_0000001223754348_li51194467143">Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax.</li><li id="css_01_0072__en-us_topic_0000001223754348_li1012004631418">JSON: Create a JSON policy or edit an existing one.</li></ul>
+<p id="css_01_0072__en-us_topic_0000001223754348_p1761612181719">For details about how to create custom policies, see <a href="https://docs.otc.t-systems.com/identity-access-management/umn/user_guide/permissions/creating_a_custom_policy.html" target="_blank" rel="noopener noreferrer">Creating a Custom Policy</a>. The following provides examples of custom CSS policies.</p>
+<div class="note" id="css_01_0072__en-us_topic_0000001223754348_note185014141059"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0072__en-us_topic_0000001223754348_p05121415516">the IAM permissions and data plane cluster permissions of CSS are managed separately. To enhance data-plane security, you need to use the security mode.</p>
+<p id="css_01_0072__en-us_topic_0000001223754348_p1133419718221">To let an IAM user access an OBS bucket, you need to grant the <strong id="css_01_0072__b529410230351">GetBucketStoragePolicy</strong>, <strong id="css_01_0072__b18294142343518">GetBucketLocation</strong>, <strong id="css_01_0072__b72941723123510">ListBucket</strong>, and <strong id="css_01_0072__b129542303514">ListAllMyBuckets</strong> permissions to the user.</p>
+</div></div>
+<ul id="css_01_0072__ul441171719011"><li id="css_01_0072__li10411017405">Example 1: Allowing users to create CSS clusters<pre class="screen" id="css_01_0072__en-us_topic_0000001223754348_screen152401381336">{
+    "Version": "1.1",
+    "Statement": [
+        {
+            "Action": [
+                "css:cluster:create",
+                "vpc:securityGroups:get",
+                "vpc:securityGroups:create",
+                "vpc:securityGroups:delete",
+                "vpc:securityGroupRules:get",
+                "vpc:securityGroupRules:create",
+                "vpc:securityGroupRules:delete",
+                "vpc:vpcs:list",
+                "vpc:privateIps:list",
+                "vpc:ports:get",
+                "vpc:ports:create",
+                "vpc:ports:update",
+                "vpc:ports:delete",
+                "vpc:quotas:list",
+                "vpc:subnets:get",
+                "ecs:cloudServerFlavors:get",
+                "ecs:serverInterfaces:use",
+                "ecs:cloudServers:addNics",
+                "ecs:quotas:get",
+                "evs:types:get",
+                "evs:quotas:get"
+            ],
+            "Effect": "Allow"
+        }
+    ]
+}</pre>
+</li><li id="css_01_0072__li1565118196013">Example 2: Denying cluster deletion<p id="css_01_0072__en-us_topic_0000001223754348_p330217517918"><a name="css_01_0072__li1565118196013"></a><a name="li1565118196013"></a>A policy with only <strong id="css_01_0072__b126831140653219">Deny</strong> permissions must be used in conjunction with other policies for it to take effect. If the permissions assigned to a user contain both <strong id="css_01_0072__b60815964053219">Allow</strong> and <strong id="css_01_0072__b60718635253219">Deny</strong>, the <strong id="css_01_0072__b198200705253219">Deny</strong> permissions take precedence over the <strong id="css_01_0072__b133336928253219">Allow</strong> permissions.</p>
+<p id="css_01_0072__en-us_topic_0000001223754348_p153024511596">The following method can be used if you need to assign permissions of the <strong id="css_01_0072__b247647353219">CSS Admin</strong> policy to a user but you want to prevent the user from deleting clusters. Create a custom policy for denying cluster deletion, and attach both policies to the group to which the user belongs. Then, the user can perform all operations on CSS except deleting clusters. The following is an example of a deny policy:</p>
+<pre class="screen" id="css_01_0072__en-us_topic_0000001223754348_screen16334701457">{ 
+      "Version": "1.1", 
+      "Statement": [ 
+            { 
+    "Effect": "Deny", 
+                  "Action": [ 
+                        "css:cluster:delete"
+                  ] 
+            } 
+      ] 
+}</pre>
+</li><li id="css_01_0072__li15457145317114">Example 3: Defining permissions for multiple services in a policy<p id="css_01_0072__p64652053519"><a name="css_01_0072__li15457145317114"></a><a name="li15457145317114"></a>A custom policy can contain the actions of multiple services that are of the global or project-level type. Example of a policy containing multiple actions:</p>
+<pre class="screen" id="css_01_0072__screen846510539118">{
+    "Version": "1.1",
+    "Statement": [
+        {
+            "Action": [
+                "ecs:cloudServers:resize",
+                "ecs:cloudServers:delete",
+                "ecs:cloudServers:delete",
+                "css:cluster:restart",
+                "css:*:get*",
+                "css:*:list*"
+            ],
+            "Effect": "Allow"
+        }
+    ]
+}</pre>
+</li></ul>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0070.html">CSS Service Permission Management</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0075.html

@@ -0,0 +1,27 @@
+<a name="css_01_0075"></a><a name="css_01_0075"></a>
+
+<h1 class="topictitle1">Setting Tags for an Elasticsearch Cluster</h1>
+<div id="body1567234141579"><p id="css_01_0075__en-us_topic_0000001223914384_p14723132511302">Tags are cluster identifiers. Adding tags to clusters can help you identify and manage your cluster resources.</p>
+<p id="css_01_0075__en-us_topic_0000001223914384_p1572313257306">You can add tags to a cluster when creating the cluster or add them on the details page of the created cluster.</p>
+<div class="section" id="css_01_0075__section269604132115"><h4 class="sectiontitle">Constraints</h4><p id="css_01_0075__p164761938589">You can create a maximum of 20 tags for a CSS cluster.</p>
+</div>
+<div class="section" id="css_01_0075__en-us_topic_0000001223914384_section13713355214"><h4 class="sectiontitle">Managing Tags</h4><p id="css_01_0075__p061991095910">In CSS, you can add, delete, modify, and query cluster tags.</p>
+<ol id="css_01_0075__en-us_topic_0000001223914384_ol7898184161913"><li id="css_01_0075__en-us_topic_0000001223914384_li1898640199">Log in to the <span id="css_01_0075__text44437119011166">CSS</span> management console.</li><li id="css_01_0075__en-us_topic_0000001223914384_li41893017190">On the <strong id="css_01_0075__en-us_topic_0000001223914384_b842352706161126">Clusters</strong> page, click the name of a cluster for which you want to manage tags.<p id="css_01_0075__en-us_topic_0000001223914384_p1585919328472">The <strong id="css_01_0075__en-us_topic_0000001223914384_b690453641219">Basic Information</strong> page is displayed.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li162741326144816">In the navigation pane on the left, choose the <strong id="css_01_0075__en-us_topic_0000001223914384_b15461977273">Tags</strong> tab. You can add, modify, or delete tags.<ul id="css_01_0075__en-us_topic_0000001223914384_ul11171525155511"><li id="css_01_0075__en-us_topic_0000001223914384_li61610259555">View<p id="css_01_0075__en-us_topic_0000001223914384_p3163256557"><a name="css_01_0075__en-us_topic_0000001223914384_li61610259555"></a><a name="en-us_topic_0000001223914384_li61610259555"></a>On the <strong id="css_01_0075__en-us_topic_0000001223914384_b842352706161835">Tags</strong> page, you can view details about tags of the cluster, including the number of tags and the key and value of each tag.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li1016182514559">Add<p id="css_01_0075__en-us_topic_0000001223914384_p1416152519553"><a name="css_01_0075__en-us_topic_0000001223914384_li1016182514559"></a><a name="en-us_topic_0000001223914384_li1016182514559"></a>Click <strong id="css_01_0075__b1327217298172">Edit Tag</strong> in the upper left corner. In the displayed dialog box, click <strong id="css_01_0075__b166325345172">Add Tag</strong>, enter the tag key and value, and click <strong id="css_01_0075__b7588210191715">OK</strong>.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li31672515510">Modify<p id="css_01_0075__en-us_topic_0000001223914384_p1116725125510"><a name="css_01_0075__en-us_topic_0000001223914384_li31672515510"></a><a name="en-us_topic_0000001223914384_li31672515510"></a>Click <strong id="css_01_0075__b14951740191713">Edit Tag</strong> in the upper left corner. In the displayed dialog box, modify the key and value of a tag, and click <strong id="css_01_0075__b1951194041713">OK</strong>.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li17166257551">Delete<p id="css_01_0075__en-us_topic_0000001223914384_p101610256555"><a name="css_01_0075__en-us_topic_0000001223914384_li17166257551"></a><a name="en-us_topic_0000001223914384_li17166257551"></a>Click <strong id="css_01_0075__b649117161817">Edit Tag</strong> in the upper left corner. In the displayed dialog box, click <strong id="css_01_0075__b1355615380183">Delete</strong> in the row that contains a tag, and click <strong id="css_01_0075__b44961781812">OK</strong>.</p>
+</li></ul>
+</li></ol>
+</div>
+<div class="section" id="css_01_0075__en-us_topic_0000001223914384_section9523193414234"><h4 class="sectiontitle">Searching for Clusters by Tag</h4><ol id="css_01_0075__en-us_topic_0000001223914384_ol580535210235"><li id="css_01_0075__en-us_topic_0000001223914384_li208055521238">Log in to the <span id="css_01_0075__text152243906711166">CSS</span> management console.</li><li id="css_01_0075__en-us_topic_0000001223914384_li5704921102415">On the <strong id="css_01_0075__b1610465375317">Clusters</strong> page, click the search box above the cluster list and select tag keys and values to search for clusters.<p id="css_01_0075__en-us_topic_0000001223914384_p13576585515">You can select a tag key or tag value from their drop-down lists. The system returns a list of clusters that exactly match the tag key or tag value. If you enter multiple tags, the cluster that meets requirements of all the tags will be filtered.</p>
+<p id="css_01_0075__en-us_topic_0000001223914384_p19175450115918">You can add a maximum of 10 tags at one time.</p>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0076.html

@@ -0,0 +1,58 @@
+<a name="css_01_0076"></a><a name="css_01_0076"></a>
+
+<h1 class="topictitle1">Configuring Public Network Access for an Elasticsearch Cluster</h1>
+<div id="body1568692028995"><p id="css_01_0076__p12915914145514">Public network access is supported only when <strong id="css_01_0076__b1588043919442">Security Mode</strong> and <strong id="css_01_0076__b1588003910445">HTTPS Access</strong> are enabled for a cluster. When <strong id="css_01_0076__b45047151456">Public IP Address</strong> is enabled, a public IP address is automatically assigned, which will enable access to the security cluster from the public network. Additionally, you can configure access control from the public network by IP addresses or IP address ranges.</p>
+<p id="css_01_0076__en-us_topic_0000001223434404_p8060118">To enable public network access for Elasticsearch or OpenSearch clusters, a shared load balancer is typically used for load balancing. If your workloads require quicker access, you are advised to use a dedicated load balancer to connect to your clusters. For details about its configuration, see <a href="css_01_0413.html">Configuring a Dedicated Load Balancer for an Elasticsearch Cluster</a>.</p>
+<div class="section" id="css_01_0076__section0594164011518"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0076__ul16345551125110"><li id="css_01_0076__li2034510517515">Enabling public network access for a CSS cluster may incur some fees, as it will need to use EIP and bandwidth resources.</li><li id="css_01_0076__li11702172312528">The security mode can be enabled only for Elasticsearch 6.5.4 clusters or later and OpenSearch clusters.</li><li id="css_01_0076__li11530152413476">Public network access and the VPC Endpoint service share a load balancer. If you configure a whitelist for public network access, and because this whitelist is deployed to the shared load balancer, it will control not only access from the public network, but also access using private IP addresses through VPCEP. In this case, you need to add IP address <strong id="css_01_0076__b2474121113146">198.19.128.0/17</strong> to the public network access whitelist to allow traffic through VPCEP.</li></ul>
+</div>
+<div class="section" id="css_01_0076__en-us_topic_0000001223434408_section1638913302523"><h4 class="sectiontitle">Configuring Public Network Access</h4><ol id="css_01_0076__en-us_topic_0000001223434408_ol1346120407506"><li id="css_01_0076__en-us_topic_0000001223434408_li154611240175011">Log in to the <span id="css_01_0076__text21595321510">CSS</span> management console.</li><li id="css_01_0076__en-us_topic_0000001223434408_li10902641195015">On the <strong id="css_01_0076__b2267115594811">Create Cluster</strong> page, enable <strong id="css_01_0076__b18111194135518">Security Mode</strong>. Set the administrator password and enable HTTPS access.</li><li id="css_01_0076__en-us_topic_0000001223434408_li0180112411579">Select <strong id="css_01_0076__b52176551438">Automatically assign</strong> for <strong id="css_01_0076__b3673111514416">Public IP Address</strong> and set related parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0076__en-us_topic_0000001223434408_table138801874019" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Public network access parameters</caption><thead align="left"><tr id="css_01_0076__en-us_topic_0000001223434408_row1888010718010"><th align="left" class="cellrowborder" valign="top" width="23.830000000000002%" id="mcps1.3.4.2.3.3.2.3.1.1"><p id="css_01_0076__en-us_topic_0000001223434408_p28805717017">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="76.17%" id="mcps1.3.4.2.3.3.2.3.1.2"><p id="css_01_0076__en-us_topic_0000001223434408_p78801371205">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0076__en-us_topic_0000001223434408_row17880271203"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.4.2.3.3.2.3.1.1 "><p id="css_01_0076__en-us_topic_0000001223434408_p38801710019">Bandwidth</p>
+</td>
+<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.4.2.3.3.2.3.1.2 "><p id="css_01_0076__en-us_topic_0000001223434408_p98801171002">Bandwidth for accessing Kibana with the public IP address</p>
+</td>
+</tr>
+<tr id="css_01_0076__en-us_topic_0000001223434408_row18880197202"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.4.2.3.3.2.3.1.1 "><p id="css_01_0076__en-us_topic_0000001223434408_p108801179017">Access Control</p>
+</td>
+<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.4.2.3.3.2.3.1.2 "><p id="css_01_0076__en-us_topic_0000001223434408_p168801175012">If you disable this function, all IP addresses can access the cluster through the public IP address. If you enable access control, only IP addresses in the whitelist can access the cluster through the public IP address.</p>
+</td>
+</tr>
+<tr id="css_01_0076__en-us_topic_0000001223434408_row2088013718014"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.4.2.3.3.2.3.1.1 "><p id="css_01_0076__en-us_topic_0000001223434408_p20880127602">Whitelist</p>
+</td>
+<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.4.2.3.3.2.3.1.2 "><p id="css_01_0076__en-us_topic_0000001223434408_p9880275012">IP address or IP address range allowed to access a cluster. Use commas (,) to separate multiple addresses. This parameter can be configured only when <strong id="css_01_0076__b36731595374">Access Control</strong> is enabled.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li></ol>
+</div>
+<div class="section" id="css_01_0076__en-us_topic_0000001223434408_section18851031541"><h4 class="sectiontitle">Configuring Public Network Access for an Existing Cluster</h4><p id="css_01_0076__en-us_topic_0000001223434408_p2871748088">You can configure, modify, view the public network access of, or disassociate the public IP address from a cluster.</p>
+<ol id="css_01_0076__en-us_topic_0000001223434408_ol179019266146"><li id="css_01_0076__en-us_topic_0000001223434408_li7625635121410">Log in to the <span id="css_01_0076__text186221420182">CSS</span> management console.</li><li id="css_01_0076__en-us_topic_0000001223434408_li106254357143">On the <span class="wintitle" id="css_01_0076__wintitle803835227104550"><b>Clusters</b></span> page, click the name of the target cluster. On the <strong id="css_01_0076__b472203816382">Basic Information</strong> page that is displayed, manage the public network access configurations.<ul id="css_01_0076__en-us_topic_0000001223434408_ul2615124316115"><li id="css_01_0076__en-us_topic_0000001223434408_li86151943141116">Configuring public network access<p id="css_01_0076__en-us_topic_0000001223434408_p16141643121114"><a name="css_01_0076__en-us_topic_0000001223434408_li86151943141116"></a><a name="en-us_topic_0000001223434408_li86151943141116"></a>If you enabled HTTPS but did not configure the public network access during security cluster creation, you can configure it on the <strong id="css_01_0076__b1992163710402">Basic Information</strong> page after configuring the cluster.</p>
+<p id="css_01_0076__en-us_topic_0000001223434408_p10615104331113">Click <strong id="css_01_0076__b10111186185514">Associate</strong> next to <strong id="css_01_0076__b46841030115517">Public IP Address</strong>, set the access bandwidth, and click <strong id="css_01_0076__b5241046185514">OK</strong>.</p>
+<p id="css_01_0076__en-us_topic_0000001223434408_p2615144321117">If the association fails, wait for a few minutes and try again.</p>
+</li><li id="css_01_0076__en-us_topic_0000001223434408_li196151143111114">Modifying public network access<p id="css_01_0076__en-us_topic_0000001223434408_p17615154381118"><a name="css_01_0076__en-us_topic_0000001223434408_li196151143111114"></a><a name="en-us_topic_0000001223434408_li196151143111114"></a>For a cluster for which you have configured public network access, you can click <strong id="css_01_0076__b07989296279">Edit</strong> next to <strong id="css_01_0076__b132681411315">Bandwidth</strong> to modify the bandwidth, or you can click <strong id="css_01_0076__b6143152183112">Set</strong> next to <strong id="css_01_0076__b269183912312">Access Control</strong> to set the access control function and the whitelist for access.</p>
+</li><li id="css_01_0076__en-us_topic_0000001223434408_li1361516431116">Checking public network access settings<p id="css_01_0076__en-us_topic_0000001223434408_p3615184381118"><a name="css_01_0076__en-us_topic_0000001223434408_li1361516431116"></a><a name="en-us_topic_0000001223434408_li1361516431116"></a>On the <strong id="css_01_0076__b1771565534414">Basic Information</strong> page, you can see the public IP address associated with the current cluster.</p>
+</li><li id="css_01_0076__en-us_topic_0000001223434408_li106151143201118">Disassociating a public IP address from a cluster<p id="css_01_0076__en-us_topic_0000001223434408_p146155436110"><a name="css_01_0076__en-us_topic_0000001223434408_li106151143201118"></a><a name="en-us_topic_0000001223434408_li106151143201118"></a>To disassociate a public IP address, click <strong id="css_01_0076__b615153014719">Disassociate</strong> next to <strong id="css_01_0076__b189482040154714">Public IP Address</strong>.</p>
+<div class="note" id="css_01_0076__note2033753713445"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0076__p4337153794412">After the public IP address is disassociated, the cluster can no longer be accessed through this IP address. If you disable public network access for a cluster and then re-enable it, the public IP address for accessing the cluster may change. Exercise caution.</p>
+</div></div>
+</li></ul>
+</li></ol>
+</div>
+<div class="section" id="css_01_0076__en-us_topic_0000001223434408_section2022235142517"><h4 class="sectiontitle">Accessing a Cluster Through the Public IP Address</h4><p id="css_01_0076__en-us_topic_0000001223434408_p5950195234910">After configuring the public IP address, you can use it to access the cluster.</p>
+<div class="p" id="css_01_0076__en-us_topic_0000001223434408_p1243345415167">For example, if the public IP address is <span class="parmname" id="css_01_0076__en-us_topic_0000001223434408_parmname15981543155911"><b>10.62.179.32</b></span> and the port number is <span class="parmname" id="css_01_0076__en-us_topic_0000001223434408_parmname189821543115912"><b>9200</b></span>, run the following cURL command to view indexes in the cluster.<pre class="screen" id="css_01_0076__en-us_topic_0000001223434408_screen85820524178">curl -u username:password -k 'https://10.62.179.32:9200/_cat/indices'</pre>
+</div>
+<p id="css_01_0076__p7424193312575">where, <strong id="css_01_0076__b223485632013">username</strong> and <strong id="css_01_0076__b916781213">password</strong> indicate the username and password of the HTTPS-enabled security-mode cluster.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0411.html">Configuring Networking for an Elasticsearch Cluster</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0079.html

@@ -0,0 +1,61 @@
+<a name="css_01_0079"></a><a name="css_01_0079"></a>
+
+<h1 class="topictitle1">Switching Between Hot and Cold Storage for an Elasticsearch Cluster</h1>
+<div id="body1571802008014"><p id="css_01_0079__p14682101612475">In an Elasticsearch cluster that has cold data nodes, index data can switch between cold and hot storage. This helps optimize storage costs and improve query performance.</p>
+<p id="css_01_0079__p194428135409">Hot/cold storage switchover is about allocating data to different types of data nodes in terms of their performance and costs based on how frequent data is expected to be accessed. Hot data nodes store real-time data that is frequently updated and queried. Typically, they use high-performance hardware (such as SSDs) to ensure fast read/write and retrieval. Cold data nodes store historical data that is seldom accessed. Typically, cold data nodes use lower-cost hardware to store data.</p>
+<div class="section" id="css_01_0079__section3941175283710"><h4 class="sectiontitle">How It Works</h4><div class="fignone" id="css_01_0079__fig9508151610273"><span class="figcap"><b>Figure 1 </b>How cold/hot storage switchover works</span><br><span><img id="css_01_0079__image1550941602716" src="en-us_image_0000001950125554.png"></span></div>
+<p id="css_01_0079__p14807112010193">When a cluster is created, cold data nodes are tagged <strong id="css_01_0079__b40095380735210">cold</strong> for cold storage, whereas regular data nodes are tagged <strong id="css_01_0079__b48580247635210">hot</strong> for hot storage. Within a cluster, you can configure to have the less frequently accessed data of specified indexes stored on cold data nodes. Compared with regular data nodes, cold data nodes offer lower query performance, but also lower storage costs. Regular data nodes will be tagged <strong id="css_01_0079__b198480916635246">hot</strong> only when there are cold data nodes.</p>
+<p id="css_01_0079__p871982116300">You can scale cold data nodes by adding or reducing nodes or their storage capacity. For details, see <a href="css_01_0414.html">Scaling an Elasticsearch Cluster</a>.</p>
+</div>
+<div class="section" id="css_01_0079__section128711933171818"><h4 class="sectiontitle">Constraints</h4><p id="css_01_0079__p1315063920182">Only clusters that have cold data nodes support switchover between cold and hot data storage. Cold data nodes can be enabled only when a cluster is created. You cannot enable cold data nodes for an existing cluster. If your cluster does not have cold data nodes but you want to cut storage costs, you can try using storage-compute decoupling. For details, see <a href="css_01_0405.html">Configuring Storage-Compute Decoupling for an Elasticsearch Cluster</a>.</p>
+</div>
+<div class="section" id="css_01_0079__en-us_topic_0000001223754344_section298814466206"><h4 class="sectiontitle">Switching Over Between Hot and Cold Storage</h4><ol id="css_01_0079__ol0195634910"><li id="css_01_0079__li15432465615">Log in to the CSS management console.</li><li id="css_01_0079__li23815221002">Check whether cold data nodes are enabled in a cluster.<div class="p" id="css_01_0079__p115342319010"><a name="css_01_0079__li23815221002"></a><a name="li23815221002"></a>On the <strong id="css_01_0079__b157638558016">Clusters</strong> page, select the cluster that you want to enable storage-compute decoupling, click the cluster name to go to the cluster information page. In the <strong id="css_01_0079__b186917472037">Node</strong> area, check whether there is information about cold data nodes.<div class="fignone" id="css_01_0079__fig81121516319"><span class="figcap"><b>Figure 2 </b>Cold data node information</span><br><span><img id="css_01_0079__image10112459316" src="en-us_image_0000001980467905.png"></span></div>
+<ul id="css_01_0079__ul105612352503"><li id="css_01_0079__li15561163517504">If there is information about cold data nodes, the cluster has cold data nodes. Go to the next step.</li><li id="css_01_0079__li256193514503">Otherwise, the cluster does not have cold data nodes, in which case, you cannot switch between cold and hot data storage.</li></ul>
+</div>
+</li><li id="css_01_0079__li074333625616">Click <strong id="css_01_0079__b79961651173313">Access Kibana</strong> in the <strong id="css_01_0079__b16642555173312">Operation</strong> column to log in to the Kibana console.</li><li id="css_01_0079__li107432036155613">Click <strong id="css_01_0079__b36339126932434">Dev Tools</strong> in the navigation tree on the left.</li><li id="css_01_0079__li169591910135014">On the Kibana page, set an index template to store index data to cold or hot data nodes.<p id="css_01_0079__p19579945714"><a name="css_01_0079__li169591910135014"></a><a name="li169591910135014"></a>For example, run the following command to set a template to store indexes that start with <strong id="css_01_0079__b553761413386">myindex</strong> to cold data nodes:</p>
+<ul id="css_01_0079__en-us_topic_0000001223754344_ul1672811231355"><li id="css_01_0079__en-us_topic_0000001223754344_li197281423651">For an Elasticsearch cluster whose version is earlier than 6.x:<pre class="screen" id="css_01_0079__en-us_topic_0000001223754344_screen1349715413531">PUT _template/test
+{
+    "order": 1,
+    "template": "myindex*",
+    "settings": {
+        "index": {
+            "refresh_interval": "30s",
+            "number_of_shards": "3",
+            "number_of_replicas": "1",
+            "routing.allocation.require.box_type": "cold"
+        }
+    }
+}</pre>
+</li><li id="css_01_0079__en-us_topic_0000001223754344_li162832403514">For an Elasticsearch cluster whose version is 6.x or later:<pre class="screen" id="css_01_0079__en-us_topic_0000001223754344_screen263614110017">PUT _template/test
+{
+  "order": 1,
+  "index_patterns": "myindex*",
+  "settings": {
+    "refresh_interval": "30s",
+    "number_of_shards": "3",
+    "number_of_replicas": "1",
+    "routing.allocation.require.box_type": "cold"
+  }
+}</pre>
+</li></ul>
+<p id="css_01_0079__p393561016361">Or you can simply specify cold or hot storage for existing indexes.</p>
+<div class="p" id="css_01_0079__p18935810183617">For example, run the following command store index <span class="parmvalue" id="css_01_0079__parmvalue12836185983510"><b>myindex</b></span> to cold data nodes:<pre class="screen" id="css_01_0079__screen683665913511">PUT <em id="css_01_0079__i383695920358">myindex</em>/_settings   
+ { 
+        "index.routing.allocation.require.box_type": "<em id="css_01_0079__i158369593357">cold</em>"
+    }</pre>
+</div>
+<p id="css_01_0079__p1393541073616"><span class="parmvalue" id="css_01_0079__parmvalue983685993513"><b>myindex</b></span> indicates the index name. You can change <span class="parmvalue" id="css_01_0079__parmvalue17837144143712"><b>cold</b></span> to <span class="parmvalue" id="css_01_0079__parmvalue14261726103712"><b>hot</b></span> if you need hot storage.</p>
+</li><li id="css_01_0079__li2360144491218">When necessary, run the following command to cancel cold or hot storage configuration. After that, index data will be randomly and evenly distributed across cold and hot data nodes.<pre class="screen" id="css_01_0079__en-us_topic_0000001223754344_screen63401826247">PUT <em id="css_01_0079__i1517061583518">myindex</em>/_settings    
+{
+        "index.routing.allocation.require.box_type": null
+    }</pre>
+<p id="css_01_0079__p188041718201617"><span class="parmvalue" id="css_01_0079__parmvalue1477041410457"><b>myindex</b></span> indicates the index name.</p>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0111.html">Enhancing Search Capabilities for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0091.html

@@ -0,0 +1,19 @@
+<a name="css_01_0091"></a><a name="css_01_0091"></a>
+
+<h1 class="topictitle1">Managing Index Policies for an Elasticsearch Cluster</h1>
+<div id="body1605181560420"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0419.html">Creating and Managing Index Policies for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0420.html">Automating Index Rollover in an Elasticsearch Cluster Through Index Lifecycle Management</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0421.html">Decoupling Index Storage and Compute in an Elasticsearch Cluster Through Index Lifecycle Management</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0111.html

@@ -0,0 +1,33 @@
+<a name="css_01_0111"></a><a name="css_01_0111"></a>
+
+<h1 class="topictitle1">Enhancing Search Capabilities for Elasticsearch Clusters</h1>
+<div id="body0000001080859855"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0400.html">Search Enhancement Features for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0405.html">Configuring Storage-Compute Decoupling for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0406.html">Configuring Flow Control 2.0 for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0407.html">Configuring Flow Control 1.0 for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0408.html">Configuring Large Query Isolation for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0409.html">Configuring Enhanced Aggregation for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0410.html">Configuring Read/Write Splitting Between Two Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0079.html">Switching Between Hot and Cold Storage for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0249.html">Configuring an Index Recycle Bin for an Elasticsearch Cluster</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0117.html

@@ -0,0 +1,29 @@
+<a name="css_01_0117"></a><a name="css_01_0117"></a>
+
+<h1 class="topictitle1">Configuring Vector Search for Elasticsearch Clusters</h1>
+<div id="body0000001080985987"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0118.html">About Vector Search</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0121.html">Creating Vector Indexes in an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0123.html">Using Vector Indexes for Data Search in an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0401.html">Using a Vector Index with Nested Fields</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0126.html">Optimizing the Write and Query Performance of Vector Search</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0130.html">Managing the Vector Index Cache</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0129.html">Client Code Sample for Vector Search (Python)</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0402.html">Client Code Sample for Vector Search (Java)</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0111.html">Enhancing Search Capabilities for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0118.html

@@ -0,0 +1,86 @@
+<a name="css_01_0118"></a><a name="css_01_0118"></a>
+
+<h1 class="topictitle1">About Vector Search</h1>
+<div id="body0000001081670505"><p id="css_01_0118__en-us_topic_0000001223594448_p443014484225">Unstructured data, such as images, videos, and language corpora, is converted into vectors, which are searched based on similarity using either an exact or approximate nearest neighbors algorithm.</p>
+<div class="section" id="css_01_0118__en-us_topic_0000001223594448_section45446533237"><h4 class="sectiontitle">How It Works</h4><p id="css_01_0118__en-us_topic_0000001223594448_p1892712312611">Vector search works in a way similar to traditional search. To improve vector search performance, we need to:</p>
+<ul id="css_01_0118__en-us_topic_0000001223594448_ul18466630152615"><li id="css_01_0118__en-us_topic_0000001223594448_li1466530102616"><strong id="css_01_0118__en-us_topic_0000001223594448_b9200126114717">Narrow down the matched scope</strong><p id="css_01_0118__en-us_topic_0000001223594448_p109274234263">Similar to traditional text search, vector search use indexes to accelerate the search instead of going through all data. Traditional text search uses inverted indexes to filter out irrelevant documents, whereas vector search creates indexes for vectors to bypass irrelevant vectors, narrowing down the search scope.</p>
+</li><li id="css_01_0118__en-us_topic_0000001223594448_li148363592612"><strong id="css_01_0118__en-us_topic_0000001223594448_b1729973134720">Reduce the complexity of calculating a single vector</strong><p id="css_01_0118__en-us_topic_0000001223594448_p1892715234266">The vector search method can quantize and approximate high dimensional vectors first. By doing this, a smaller and more relevant dataset can be obtained. Then more sophisticated algorithms are applied to this smaller dataset to perform computation and sorting. This way, complex computation is performed on only part of the vectors, and efficiency is improved.</p>
+</li></ul>
+<p id="css_01_0118__en-us_topic_0000001223594448_p4672653151113">Vector search means to retrieve the k-nearest neighbors (KNN) to the query vector in a given vector data set by using a specific measurement method. Generally, CSS only focuses on Approximate Nearest Neighbor (ANN), because a KNN search requires excessive computational resources.</p>
+</div>
+<div class="section" id="css_01_0118__en-us_topic_0000001223594448_section1682114111274"><h4 class="sectiontitle">Vector Search in CSS</h4><p id="css_01_0118__en-us_topic_0000001223594448_p368234122719">The CSS vector search engine integrates a variety of vector indexes, such as brute-force search, Hierarchical Navigable Small World (HNSW) graphs, product quantization, and IVF-HNSW. It also supports multiple similarity calculation methods, such as Euclidean, inner product, cosine, and Hamming. The recall rate and retrieval performance of the engine are better than those of open-source engines. It can meet the requirements for high performance, high precision, low costs, and multi-modal computation.</p>
+<p id="css_01_0118__en-us_topic_0000001223594448_p3682194119271">The search engine also supports all the capabilities of the native Elasticsearch, including distribution, multi-replica, error recovery, snapshot, and permission control. The engine is compatible with the native Elasticsearch ecosystem, including the cluster monitoring tool Cerebro, the visualization tool Kibana, and the real-time data ingestion tool Logstash. Several client languages, such as Python, Java, Go, and C++, are supported.</p>
+</div>
+<div class="section" id="css_01_0118__en-us_topic_0000001223594448_section15508103014206"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0118__en-us_topic_0000001223594448_ul13628842142018"><li id="css_01_0118__li0239191816816">The built-in CSS vector search engine is available for Elasticsearch 7.6.2 and 7.10.2 clusters only.</li><li id="css_01_0118__en-us_topic_0000001223594448_li1462834282015">The vector search plug-in performs in-memory computing and requires more memory than common indexes do. You are advised to use memory-optimized compute specifications.</li></ul>
+</div>
+<div class="section" id="css_01_0118__section18221195417136"><a name="css_01_0118__section18221195417136"></a><a name="section18221195417136"></a><h4 class="sectiontitle">Cluster Node Specifications Selection for Vector Search</h4><p id="css_01_0118__en-us_topic_0000001261909812_p2804352104215">Off-heap memory is used for index construction and query in vector search. Therefore, the required cluster capacity is related to the index type and off-heap memory size. You can estimate the off-heap memory required by full indexing to select the appropriate cluster specifications. Due to high memory usage of vector search, CSS disables the vector search plug-in by default for clusters whose memory is 8 GB or less.</p>
+<div class="p" id="css_01_0118__en-us_topic_0000001261909812_p1216235123617">There are different methods for estimating the size of off-heap memory required by different types of indexes. The calculation formulas are as follows:<ul id="css_01_0118__en-us_topic_0000001261909812_ul1626234143110"><li id="css_01_0118__en-us_topic_0000001261909812_li122610343315"><strong id="css_01_0118__b2042219402161">GRAPH index</strong><p id="css_01_0118__p3907152119169"><span id="css_01_0118__ph174514153911">mem_needs = (dim x dim_size + neighbors x 4) x num + delta</span></p>
+<div class="note" id="css_01_0118__en-us_topic_0000001261909812_note264165903915"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0118__en-us_topic_0000001261909812_p1164155923917">If you need to update indexes in real time, consider the off-heap memory overhead required for vector index construction and automatic merge. The actual size of required <strong id="css_01_0118__b1788741085413">mem_needs</strong> is at least 1.5 to 2 times of the original estimation.</p>
+</div></div>
+</li><li id="css_01_0118__en-us_topic_0000001261909812_li4981114418312"><strong id="css_01_0118__en-us_topic_0000001261909812_b11437195014419">PQ index</strong><p id="css_01_0118__p25749308240">mem_needs = frag_num x frag_size x num + delta</p>
+</li><li id="css_01_0118__en-us_topic_0000001261909812_li85212188414"><strong id="css_01_0118__en-us_topic_0000001261909812_b16836553134119">FLAT and IVF indexes</strong><p id="css_01_0118__p1318663214249">mem_needs = dim x dim_size x num + delta</p>
+</li></ul>
+
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0118__en-us_topic_0000001261909812_table1875348443" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_01_0118__en-us_topic_0000001261909812_row276174134419"><th align="left" class="cellrowborder" valign="top" width="28.89%" id="mcps1.3.5.3.2.2.3.1.1"><p id="css_01_0118__en-us_topic_0000001261909812_p1876841448">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="71.11%" id="mcps1.3.5.3.2.2.3.1.2"><p id="css_01_0118__en-us_topic_0000001261909812_p14761464413">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0118__en-us_topic_0000001261909812_row107613413445"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p0761943444">dim</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p27614484419">Vector dimensionality</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row47616484416"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p15767474413">neighbors</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p187644154418">Number of neighbors of a graph node. The default value is <strong id="css_01_0118__b116222947734835">64</strong>.</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row197616434417"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p6763411446">dim_size</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p16769444420">Number of bytes required by each dimension. The default value is four bytes in the float type.</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row6764416440"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p18765444414">num</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p6761845447">Total number of vectors</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row97613454416"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p137611413447">delta</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p157613464410">Metadata size. This parameter can be left blank.</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row27612424419"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p076144114413">frag_num</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p276114154418">Number of vector segments during quantization and coding. If this parameter is not specified when an index is created, the value is determined by vector dimensionality <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname32491715164713"><b>dim</b></span>.</p>
+<pre class="screen" id="css_01_0118__en-us_topic_0000001261909812_screen28239236473">if dim &lt;= 256: 
+  frag_num = dim / 4
+elif dim &lt;= 512: 
+  frag_num = dim / 8
+else :
+  frag_num = 64</pre>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row187684104410"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p776846446">frag_size</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p87604154416">Size of the center point during quantization and coding. The default value is 1.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<p id="css_01_0118__en-us_topic_0000001261909812_p19203914115119">These calculation methods can estimate the size of off-heap memory required by a complete vector index. To determine cluster specifications, you also need to consider the heap memory overhead of each node.</p>
+<p id="css_01_0118__en-us_topic_0000001261909812_p53134525012">Heap memory allocation policy: The size of the heap memory of each node is half of the node physical memory, and the maximum size is <strong id="css_01_0118__b107546537334835">31 GB</strong>.</p>
+<p id="css_01_0118__en-us_topic_0000001261909812_p16313452502">For example, if you create a Graph index for the SIFT10M dataset, with <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname1113013488515"><b>dim</b></span> set to <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue13734161255216"><b>128</b></span>, <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname8379010185210"><b>dim_size</b></span> to <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue1197581115311"><b>4</b></span>, <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname2411772538"><b>neighbors</b></span> to the default value <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue11371171312536"><b>64</b></span>, and <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname1086192219533"><b>num</b></span> to <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue978262955317"><b>10 million</b></span>, the off-heap memory required by the Graph index is around 7.5 GB. Calculation formula: <span class="parmvalue" id="css_01_0118__parmvalue6249757174112"><b>mem_needs = (128 x 4 + 64 x 4) x 10000000 ≈ 7.5</b></span>.</p>
+<p id="css_01_0118__en-us_topic_0000001261909812_p531317519506">Considering the overhead of heap memory, a single server with <strong id="css_01_0118__b552412312592">8 vCPUs</strong> and <strong id="css_01_0118__b2571330334835">16 GB memory</strong> is recommended. If real-time write or update is required, you need to apply for larger memory.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0126.html

@@ -0,0 +1,42 @@
+<a name="css_01_0126"></a><a name="css_01_0126"></a>
+
+<h1 class="topictitle1">Optimizing the Write and Query Performance of Vector Search</h1>
+<div id="body0000001262069744"><div class="section" id="css_01_0126__en-us_topic_0000001262069744_section186411329173012"><h4 class="sectiontitle">Optimizing Write Performance</h4><ul id="css_01_0126__en-us_topic_0000001262069744_ul09461057164113"><li id="css_01_0126__en-us_topic_0000001262069744_li189761389357">To reduce the cost of backup, disable the backup function before data import and enable it afterwards.</li><li id="css_01_0126__en-us_topic_0000001262069744_li27411942123713">Set <span class="parmname" id="css_01_0126__en-us_topic_0000001262069744_parmname877971815344"><b>refresh_interval</b></span> to <strong id="css_01_0126__en-us_topic_0000001262069744_b1176015317388">120s</strong> or a larger value. Larger segments can reduce the vector index build overhead caused by merging.</li><li id="css_01_0126__en-us_topic_0000001262069744_li1053491484012">Increase the value of <span class="parmname" id="css_01_0126__en-us_topic_0000001262069744_parmname18272105316343"><b>native.vector.index_threads</b></span> (the default value is <strong id="css_01_0126__en-us_topic_0000001262069744_b11648194418458">4</strong>) to increase the number of threads for vector index build.<pre class="screen" id="css_01_0126__en-us_topic_0000001262069744_screen28631532420">PUT _cluster/settings
+{
+  "persistent": {
+    "native.vector.index_threads": 8
+  }
+}</pre>
+</li></ul>
+</div>
+<div class="section" id="css_01_0126__en-us_topic_0000001262069744_section527113518302"><h4 class="sectiontitle">Optimizing Query Performance</h4><ul id="css_01_0126__en-us_topic_0000001262069744_ul1388130134412"><li id="css_01_0126__en-us_topic_0000001262069744_li1456725974318">After importing data in batches, you can run the <strong id="css_01_0126__en-us_topic_0000001262069744_b168089591364">forcemerge</strong> command to improve the query efficiency.<pre class="screen" id="css_01_0126__en-us_topic_0000001262069744_screen3998132772116">POST index_name/_forcemerge?max_num_segments=1</pre>
+</li></ul>
+<ul id="css_01_0126__en-us_topic_0000001262069744_ul269911532210"><li id="css_01_0126__en-us_topic_0000001262069744_li56213018222">If the off-heap memory required by the vector index exceeds the circuit breaker limit, index entry swap-in and swap-out occur, which affects the query performance. In this case, you can increase the circuit breaker threshold of off-heap memory.<pre class="screen" id="css_01_0126__en-us_topic_0000001262069744_screen9611125582411">PUT _cluster/settings
+{
+  "persistent": {
+    "native.cache.circuit_breaker.cpu.limit": "75%"
+  }
+}</pre>
+</li><li id="css_01_0126__li148341156892">To fetch a small number of fields that support doc values, such as keywords and numerical fields, use the docvalue_fields parameter to specify the fields you want to fetch. This helps to reduce overhead during the fetch phase.<pre class="screen" id="css_01_0126__en-us_topic_0000001268154489_screen1466920229569">POST my_index/_search
+{
+  "size": 2,
+  "stored_fields": ["_none_"], 
+  "docvalue_fields": ["my_label"],
+  "query": {
+    "vector": {
+      "my_vector": {
+        "vector": [1, 1],
+        "topk": 2
+      }
+    }
+  }
+}</pre>
+</li></ul>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0130.html

@@ -0,0 +1,19 @@
+<a name="css_01_0130"></a><a name="css_01_0130"></a>
+
+<h1 class="topictitle1">Managing the Vector Index Cache</h1>
+<div id="body0000001200234616"><p id="css_01_0130__en-us_topic_0000001268154549_p9773716335">The vector search engine is developed in C++ and uses off-heap memory. You can use the following APIs to manage the index cache.</p>
+<ul id="css_01_0130__en-us_topic_0000001268154549_ul4779753312"><li id="css_01_0130__en-us_topic_0000001268154549_li6770717336"><strong id="css_01_0130__en-us_topic_0000001268154549_b1919783612367">View cache statistics.</strong><pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen16934641315">GET /_vector/stats</pre>
+<p id="css_01_0130__en-us_topic_0000001268154549_p1977210351817">In the implementation of the vector plug-in, the vector index is the same as other types of Lucene indexes. Each segment constructs and stores an index file. During query, the index file is loaded to the non-heap memory. The plug-in uses the cache mechanism to manage the non-heap memory. You can use this API to query the non-heap memory usage, number of cache hits, and number of loading times.</p>
+</li><li id="css_01_0130__en-us_topic_0000001268154549_li295515542292"><strong id="css_01_0130__en-us_topic_0000001268154549_b136281519203916">Preload the vector index.</strong><pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen3693164910305">PUT /_vector/warmup/{index_name}</pre>
+<p id="css_01_0130__en-us_topic_0000001268154549_p28561843163016">You can use this API to preload the vector index specified by <strong id="css_01_0130__en-us_topic_0000001268154549_b612616506486">index_name</strong> to the off-heap memory for query.</p>
+</li><li id="css_01_0130__en-us_topic_0000001268154549_li1477147103311"><strong id="css_01_0130__en-us_topic_0000001268154549_b12737115474510">Clear the cache.</strong><pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen62573551112">PUT /_vector/clear/cache </pre>
+<pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen178541841152315">PUT /_vector/clear/cache/index_name</pre>
+<p id="css_01_0130__en-us_topic_0000001268154549_p1170584816113">The caching mechanism limits the non-heap memory usage when vector indexes are used. When the total index size exceeds the cache size limit, index entry swap-in and swap-out occur, which affects the query performance. You can use this API to clear unnecessary index cache to ensure the query performance of hot data indexes.</p>
+</li></ul>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></div>
+</div>
+</div>
+