- What's New
- Function Overview
- Product Bulletin
- Service Overview
- Billing
- Getting Started
-
User Guide
- CSS Service Permission Management
-
Using Elasticsearch for Data Search
- Procedure for Using Elasticsearch
- Elasticsearch Cluster Planning Suggestions
- Creating an Elasticsearch Cluster
-
Accessing Elasticsearch Clusters
- Elasticsearch Cluster Access Methods
- Logging In to an Elasticsearch Cluster Using Kibana
- Logging In to an Elasticsearch Cluster Through Cerebro
- Accessing an Elasticsearch Cluster Using cURL Commands
- Accessing an Elasticsearch Cluster Using Java
- Accessing an Elasticsearch Cluster Using Python
- Accessing an Elasticsearch Cluster Through the MRS Hive Client
- Accessing an Elasticsearch Cluster Using Go
- Accessing an Elasticsearch Cluster Using LDAP
- Importing Data to an Elasticsearch Cluster
- Searching Data in an Elasticsearch Cluster
-
Enhancing Search Capabilities for Elasticsearch Clusters
- Search Enhancement Features for Elasticsearch Clusters
-
Configuring Vector Search for Elasticsearch Clusters
- About Vector Search
- Creating Vector Indexes in an Elasticsearch Cluster
- Using Vector Indexes for Data Search in an Elasticsearch Cluster
- Using a Vector Index with Nested Fields
- Optimizing the Write and Query Performance of Vector Search
- Managing the Vector Index Cache
- Client Code Sample for Vector Search (Python)
- Client Code Sample for Vector Search (Java)
- Configuring Storage-Compute Decoupling for an Elasticsearch Cluster
- Configuring Flow Control 2.0 for an Elasticsearch Cluster
- Configuring Flow Control 1.0 for an Elasticsearch Cluster
- Configuring Large Query Isolation for an Elasticsearch Cluster
- Configuring Enhanced Aggregation for an Elasticsearch Cluster
- Configuring Read/Write Splitting Between Two Elasticsearch Clusters
- Switching Between Hot and Cold Storage for an Elasticsearch Cluster
- Configuring an Index Recycle Bin for an Elasticsearch Cluster
- Configuring Networking for an Elasticsearch Cluster
- Backing up and Restoring the Data of an Elasticsearch Cluster
- Scaling an Elasticsearch Cluster
- Upgrading the Version of an Elasticsearch Cluster
-
Managing Elasticsearch Clusters
- Viewing Elasticsearch Cluster Information
- Creating Users for an Elasticsearch Cluster and Granting Cluster Access
- Setting Tags for an Elasticsearch Cluster
- Configuring Default Parameters in the .yml Configuration File of an Elasticsearch Cluster
- Binding an Elasticsearch Cluster to an Enterprise Project
- Changing the Node Specifications of an Elasticsearch Cluster
- Replacing Specified Nodes for an Elasticsearch Cluster
- Changing the Security Mode of an Elasticsearch Cluster
- Switching AZs for an Elasticsearch Cluster
- Configuring Custom Word Dictionaries for an Elasticsearch Cluster
- Switching Between Simplified and Traditional Chinese for Data Search in an Elasticsearch Cluster
- Restarting an Elasticsearch Cluster
- Deleting an Elasticsearch Cluster
- Managing Index Policies for an Elasticsearch Cluster
- Elasticsearch Cluster Monitoring and Log Management
- Viewing Elasticsearch Cluster Audit Logs
-
Using OpenSearch for Data Search
- Procedure for Using OpenSearch
- OpenSearch Cluster Planning Suggestions
- Creating an OpenSearch Cluster
- Accessing an OpenSearch Cluster
-
Importing Data to an OpenSearch Cluster
- Different Ways to Import Data to an OpenSearch Cluster
- Using In-house Built Logstash to Import Data to an OpenSearch Cluster
- Using Open Source OpenSearch APIs to Import Data to an OpenSearch Cluster
- Using CDM to Import Data to an OpenSearch Cluster
- Enhancing the Data Import Performance of OpenSearch Clusters
- Searching Data in an OpenSearch Cluster
-
Enhancing Search Capabilities for OpenSearch Clusters
- Search Enhancement Features for OpenSearch Clusters
-
Configuring Vector Search for OpenSearch Clusters
- About Vector Search
- Creating Vector Indexes in an OpenSearch Cluster
- Using Vector Indexes for Data Search in an OpenSearch Cluster
- Optimizing the Write and Query Performance of Vector Search
- Managing the Vector Index Cache
- Client Code Sample for Vector Search (Python)
- Client Code Sample for Vector Search (Java)
- Configuring Storage-Compute Decoupling for an OpenSearch Cluster
- Switching Between Hot and Cold Storage for an OpenSearch Cluster
- Configuring Networking for an OpenSearch Cluster
- Backing up and Restoring the Data of an OpenSearch Cluster
- Scaling an OpenSearch Cluster
- Upgrading the Version of an OpenSearch Cluster
-
Managing OpenSearch Clusters
- Viewing OpenSearch Cluster Information
- Creating Users for an OpenSearch Cluster and Granting Cluster Access
- Setting Tags for an OpenSearch Cluster
- Configuring Default Parameters in the .yml Configuration File of an OpenSearch Cluster
- Binding an OpenSearch Cluster to an Enterprise Project
- Changing the Node Specifications of an OpenSearch Cluster
- Replacing Specified Nodes for an OpenSearch Cluster
- Changing the Security Mode of an OpenSearch Cluster
- Switching AZs for an OpenSearch Cluster
- Configuring Custom Word Dictionaries for an OpenSearch Cluster
- Switching Between Simplified and Traditional Chinese for Data Search in an OpenSearch Cluster
- Restarting an OpenSearch Cluster
- Deleting an OpenSearch Cluster
- Managing Index Policies for OpenSearch Clusters
- OpenSearch Cluster Monitoring and Log Management
- Viewing OpenSearch Cluster Audit Logs
-
Using Logstash for Data Migration
- Procedure for Using Logstash
- Logstash Cluster Planning Suggestions
- Creating a Logstash Cluster
- Configuring Routes for a Logstash Cluster
- Configuring a Logstash Migration Task
- Scaling a Logstash Cluster
- Managing Logstash Clusters
- Logstash Cluster Monitoring and Log Management
- Viewing Logstash Cluster Audit Logs
- CSS Resource Monitoring
-
Best Practices
-
Elasticsearch Data Migration
- About Elasticsearch Cluster Migration Solutions
- Migrating Data Between Elasticsearch Clusters Using Huawei Cloud Logstash
- Migrating Data Between Huawei Cloud Elasticsearch Clusters Using Backup and Restoration
- Migrating Data from an On-premises Elasticsearch Cluster to Huawei Cloud Using the S3 Plugin
- Migrating Data from a Third-Party Elasticsearch Cluster to Huawei Cloud Using Backup and Restoration
- Migrating Data Between Huawei Cloud Elasticsearch Clusters Using the Read/Write Splitting Plugin
- Migrating Data Between Elasticsearch Clusters Using the Reindex API
- Migrating Data Between Elasticsearch Clusters Using ESM
- Migrating Kibana Saved Objects Between Elasticsearch Clusters
- Optimizing the Performance of Elasticsearch and OpenSearch Clusters
- Testing the Performance of CSS's Elasticsearch Vector Search
- Using Elasticsearch to Accelerate Query and Analysis for Relational Databases
- Using Elasticsearch, In-House Built Logstash, and Kibana to Build a Log Management Platform
- Ranking Search Results Using Elasticsearch Custom Rules
- Synchronizing Data from RDS for MySQL to Elasticsearch Through Logstash
-
Elasticsearch Data Migration
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
-
Cluster Management
- Creating a cluster
- Querying the Cluster List
- Querying Cluster Details
- Deleting a Cluster
- Changing the Cluster Billing Mode from Pay-per-use to Yearly/Monthly
- Renaming a Cluster
- Changing the Password of a Cluster
- Restarting a Cluster (Deprecated)
- Scaling Out a Cluster
- Adding Instances and Expanding Instance Storage Capacity
- Changing Specifications
- Obtaining the Instance Specifications List
- Querying All Tags
- Querying Tags of a Specified Cluster
- Adding Tags to a Cluster
- Deleting a Cluster Tag
- Adding or Deleting Cluster Tags in Batches
- Scaling In a Cluster by Removing a Specific Node
- Change the specifications of a specified node type.
- Scaling In Nodes of a Specific Type
- Downloading a Security Certificate
- Replacing a Node
- Configuring the Security Mode.
- Adding Independent Masters and Clients
- Upgrading a Cluster Kernel
- Obtaining the ID of the Target Image to Upgrade To
- Obtaining Details About a Cluster Upgrade or AZ Switchover
- Retrying a Failed Upgrade Task
- Changing the Security Group
- Changing the AZ of a Cluster Instance
- Creating a Cluster (V2)
- Restarting a Cluster (V2)
- Rolling Restart
- Word Dictionary Management
- Kibana Public Network Access
-
Logstash
- Creating a Configuration File
- Updating a Configuration File
- Starting Pipeline Data Migration
- Stopping Pipeline Data Migration
- Adding a Custom Template
- Performing a Connectivity Test
- Querying the Template List
- Querying the Configuration File List
- Querying the Pipeline List
- Querying Operation Records
- Querying the Configuration File Content
- Deleting a Configuration File
- Deleting a Custom Template
- Hot Starting Pipeline Data Migration
- Hot Stopping Pipeline Data Migration
- Updating Cluster Routes
- Obtaining a Cluster Route
- Uploading a Certificate
- Querying the Certificate List
- Querying Certificate Information
- Deleting a Certificate
- Delete a Configuration File (V2)
- Delete a Custom Template V2
- Log Management
- Public Network Access
-
Snapshot Management
- (Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot
- Modifying Basic Configurations of a Cluster Snapshot
- Manually Creating a Snapshot
- Restoring a Snapshot
- Deleting a Snapshot
- Configuring the Automatic Snapshot Creation Policy
- Querying the Automatic Snapshot Creation Policy
- Querying a Snapshot List
- Disabling the Snapshot Function
- Enabling Automatic Snapshot Creation
- Disabling Automatic Snapshot Creation
- VPC Endpoint
- Parameter Configuration
- Intelligent O&M
- Load Balancing
-
Cluster Management
- Examples
- Permissions and Supported Actions
- Appendixes
- SDK Reference
-
FAQs
- General Consulting
-
Accessing CSS Clusters
- How Do I Reset the Administrator Password of a Security-mode Cluster in CSS?
- Are Ports 9200 and 9300 Open for Access to Elasticsearch Clusters?
- How Do I Use a NAT Gateway to Access CSS from the Internet?
- How Do I Connect In-house Developed Kibana to an Elasticsearch Cluster in CSS?
- How Do I Connect In-house Developed OpenSearch Dashboards to an OpenSearch Cluster in CSS?
- Migrating CSS Clusters
-
Using CSS Cluster Search Engines
- Why Are Newly Created Index Shards Allocated to a Single Node in CSS?
- How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster of CSS?
- How Do I Change the Number of Replicas for Elasticsearch Indexes in CSS?
- What Are the Impacts If an Elasticsearch Cluster of CSS Has Too Many Shards?
- How Do I Check the Number of Shards and Replicas in a CSS Cluster?
- What Does the Value i for node.roles Mean for Nodes in an Elasticsearch Cluster of CSS?
- How Do I Change the Maximum Number of Results Returned for Searches to an Index in an Elasticsearch Cluster of CSS?
- How Do I Update Index Lifecycle Policies for an Elasticsearch Cluster of CSS?
- How Do I Set Slow Query Log Thresholds for an Elasticsearch Cluster of CSS?
- How Do I Clear Elasticsearch Indexes in CSS?
- How Do I Clear Elasticsearch Cache in CSS?
- Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data in an Elasticsearch Cluster?
- Do CSS Elasticsearch Clusters Support script dotProduct?
-
Managing CSS Clusters
- How Do I Check the AZ Where a CSS Cluster Is Located?
- What Is the Relationship Between the Filebeat Version and Cluster Version in CSS?
- How Do I Obtain the Security Certificate of CSS?
- How Do I Convert the Format of a CER Security Certificate in CSS?
- Can I Modify the Security Group for Elasticsearch and OpenSearch Clusters in CSS?
- How Do I Set search.max_buckets for an Elasticsearch Cluster of CSS?
- Can I Modify the TLS Algorithm of an Elasticsearch or OpenSearch Cluster in CSS?
- How Do I Enable Audit Logs for an Elasticsearch or OpenSearch Cluster of CSS?
- Can I Stop a CSS Cluster?
- How Do I Query the Index Size on OBS After the Freezing of Indexes for a CSS Cluster?
- How Do I Check the List of Default Plugins for Elasticsearch and OpenSearch Clusters?
- CSS Cluster Backup and Restoration
- CSS Cluster Monitoring and O&M
-
Troubleshooting
-
Clusters
- Failed to Open Kibana
- How Can I Improve Filebeat Performance?
- How Do I Handle the Error "Connection reset by peer" That Occurs When Spring Boot Uses Elasticsearch?
- Why Does Cluster Creation Fail?
- What Do I Do If "Bulk Reject" Is Displayed in an Elasticsearch Cluster?
- What Do I Do If I Failed to Create an Index Pattern in an Elasticsearch Cluster?
- What Do I Do If a Message Indicating that the System Is Busy Is Displayed on the CSS Console?
- An Elasticsearch Cluster Reports An Error Message "unassigned shards all indices"
- A Cross-Domain Error Is Reported When I Connect the es-head Plugin to an Elasticsearch Cluster
- An Alarm Is Displayed When I Access Cerebro Through a Single-Node Cluster
- Why Does My ECS Fail to Connect to a Cluster?
-
Unavailable Clusters
- What Do I Do If My Cluster Status Is Unavailable?
- A Cluster Is Frozen and Unavailable
- What Can I Do If My Custer Is Unavailable Due to an X-pack Parameter Configuration?
- A Cluster Is Unavailable Due to Improper Security Group Policy
- A Cluster is Unavailable Due to Plugin Incompatibility
- A Cluster is Unavailable Due to Improper Shard Allocation
- A Cluster is Unavailable Due to Incompatible Data Types
- A Cluster is Unavailable Due to Heavy Load
- Data Import and Export
-
Functions
- Why Does Index Backup Fail?
- Why Is the Word Dictionary Function Not Working?
- What Do I Do If the Snapshot Repository Cannot Be Found?
- What Do I Do If a Cluster Is Always in the Snapshot Creation State?
- How Do I Back Up Large Amounts of Data Using Snapshots?
- How Can I Troubleshoot a Cluster With an Abnormally Heavy Load?
- Why "I/O Reactor STOPPED" Is Reported When I Use the Elasticsearch HLRC?
- The Peak Heap Memory of an Elasticsearch Cluster Remains High (Over 90%)
- Failed to Modify the Elasticsearch Cluster Specifications
- An Error Message Is Displayed When I Change the Read-Only Status of an Index
- A Node in an Elasticsearch Cluster Has No Shards Allocated
- Failed to Insert Data into a Cluster Index
- Error Message "maximum shards open" Is Displayed When Users Try to Create an Index
- Error Message "403 Forbidden" Is Displayed When I Delete All Indexes
- Error Message "Forbidden" Is Displayed When I Delete an Index Pattern
- Error Message "Trying to create too many scroll contexts" Is Displayed When the update-by-query Command Is Executed
- Failed to Create a Pattern in an Elasticsearch Cluster
- Ports
-
Clusters
- Videos
- Glossary
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Permissions Management
- Creating and Accessing a Cluster
- Scaling In/Out a Cluster
- Importing Data to Elasticsearch
-
Managing Elasticsearch Clusters
- Cluster and Storage Capacity Statuses
- Introduction to the Cluster List
- Index Backup and Restoration
- Binding an Enterprise Project
- Restarting a Cluster
- Migrating Cluster Data
- Deleting a Cluster
- Managing Tags
- Public Network Access
- Managing Logs
- Managing Plugins
- Hot and Cold Data Storage
- Configuring Parameters
- Vector Retrieval
- Working with Kibana
- Elasticsearch SQL
- Enhanced Features
- Monitoring
- Auditing
-
FAQs
-
General Consulting
- What Are Regions and AZs?
- How Does CSS Ensure Data and Service Security?
- Which CSS Metrics Should I Focus On?
- What Storage Options Does CSS Provide?
- What Is the Maximum Storage Capacity of CSS?
- How Can I Manage CSS?
- What Can the Disk Space of a CSS Cluster Be Used For?
- How Do I Check the Numbers of Shards and Replicas in a Cluster on the CSS Console?
- What Data Compression Algorithms Does CSS Use?
-
Functions
- Can Elasticsearch Data Be Migrated Between VPCs?
- How Do I Migrate a CSS Cluster Across Regions?
- How Do I Configure the Threshold for CSS Slow Query Logs?
- How Do I Update the CSS Lifecycle Policy?
- How Do I Set the Numbers of Index Copies to 0 in Batches?
- Why All New Index Shards Are Allocated to the Same Node?
- How Do I Query Snapshot Information?
- Can I Upgrade a Cluster from an Earlier Version to a Later Version?
- Can I Restore a Deleted Cluster?
- Can I Modify the TLS Algorithm of an Elasticsearch Cluster?
- How Do I Set the search.max_buckets Parameter for an ES Cluster?
- Does the Value i of node.roles Indicate an Injest Node?
- How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster?
- Clusters in Security Mode
-
Resource Usage and Change
- How Do I Clear Expired Data to Release Storage Space?
- How Do I Configure a Two-Replica CSS Cluster?
- How Do I Delete Index Data?
- Can I Change the Number of Shards to Four with Two Replicas When There Is One Shard Set in the JSON File?
- What Are the Impacts If an Elasticsearch Cluster Has Too Many Shards?
- How Do I Set the Default Maximum Number of Records Displayed on a Page for an Elasticsearch Cluster
- Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data?
- How Do I Clear the Cache of a CSS Cluster?
- The Average Memory Usage of an Elasticsearch Cluster Reaches 98%
- Components
- Kibana
- Clusters
- Ports
-
General Consulting
- Change History
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
Cluster Management
- Creating a cluster
- Querying the Cluster List
- Querying Cluster Details
- Deleting a Cluster
- Renaming a Cluster
- Changing the Password of a Cluster
- Restarting a Cluster
- Scaling Out a Cluster
- Adding Instances and Expanding Instance Storage Capacity
- Changing Specifications
- Obtaining the Instance Specifications List
- Querying All Tags
- Querying Tags of a Specified Cluster
- Adding Tags to a Cluster
- Deleting a Cluster Tag
- Adding or Deleting Cluster Tags in Batches
- Changing the Specifications of a Specified Node Type
- Scaling In a Cluster by Removing a Specific Node
- Scaling In Nodes of a Specific Type
- Downloading a Security Certificate
- Log Management
- Public Network Access
-
Snapshot Management
- (Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot
- Modifying Basic Configurations of a Cluster Snapshot
- Manually Creating a Snapshot
- Restoring a Snapshot
- Deleting a Snapshot
- Configuring the Automatic Snapshot Creation Policy
- Querying the Automatic Snapshot Creation Policy
- Querying a Snapshot List
- Disabling the Snapshot Function
- Parameter Configuration
- Permissions Policies and Supported Actions
- Common Parameters
- Change History
-
User Guide (Paris and Amsterdam Regions)
- Overview
- Getting Started
- Permissions Management
- Creating and Accessing a Cluster
- Scaling In/Out a Cluster
- Importing Data to Elasticsearch
-
Managing Elasticsearch Clusters
- Cluster and Storage Capacity Statuses
- Introduction to the Cluster List
- Index Backup and Restoration
- Binding an Enterprise Project
- Restarting a Cluster
- Migrating Cluster Data
- Deleting a Cluster
- Managing Tags
- Public Network Access
- Managing Logs
- Managing Plugins
- Hot and Cold Data Storage
- Configuring Parameters
- VPC Endpoint Service
- Kibana Public Access
- Vector Retrieval
- Working with Kibana
- Elasticsearch SQL
- Enhanced Features
- Monitoring
- Auditing
- Best Practices
-
FAQs
-
General Consulting
- What Are Regions and AZs?
- How Does CSS Ensure Data and Service Security?
- Which CSS Metrics Should I Focus On?
- What Storage Options Does CSS Provide?
- What Is the Maximum Storage Capacity of CSS?
- How Can I Manage CSS?
- What Can the Disk Space of a CSS Cluster Be Used For?
- How Do I Check the Numbers of Shards and Replicas in a Cluster on the CSS Console?
- What Data Compression Algorithms Does CSS Use?
-
Functions
- Can Elasticsearch Data Be Migrated Between VPCs?
- How Do I Migrate a CSS Cluster Across Regions?
- How Do I Configure the Threshold for CSS Slow Query Logs?
- How Do I Update the CSS Lifecycle Policy?
- How Do I Set the Numbers of Index Copies to 0 in Batches?
- Why All New Index Shards Are Allocated to the Same Node?
- How Do I Query Snapshot Information?
- Can I Upgrade a Cluster from an Earlier Version to a Later Version?
- Can I Restore a Deleted Cluster?
- Can I Modify the TLS Algorithm of an Elasticsearch Cluster?
- How Do I Set the search.max_buckets Parameter for an ES Cluster?
- Does the Value i of node.roles Indicate an Injest Node?
- How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster?
- Clusters in Security Mode
-
Resource Usage and Change
- How Do I Clear Expired Data to Release Storage Space?
- How Do I Configure a Two-Replica CSS Cluster?
- How Do I Delete Index Data?
- Can I Change the Number of Shards to Four with Two Replicas When There Is One Shard Set in the JSON File?
- What Are the Impacts If an Elasticsearch Cluster Has Too Many Shards?
- How Do I Set the Default Maximum Number of Records Displayed on a Page for an Elasticsearch Cluster
- Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data?
- How Do I Clear the Cache of a CSS Cluster?
- The Average Memory Usage of an Elasticsearch Cluster Reaches 98%
- Components
- Kibana
- Clusters
- Ports
-
General Consulting
- Change History
-
API Reference (Paris and Amsterdam Regions)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
Cluster Management
- Creating a cluster
- Querying the Cluster List
- Querying Cluster Details
- Deleting a Cluster
- Renaming a Cluster
- Changing the Password of a Cluster
- Restarting a Cluster
- Scaling Out a Cluster
- Adding Instances and Expanding Instance Storage Capacity
- Changing Specifications
- Obtaining the Instance Specifications List
- Querying All Tags
- Querying Tags of a Specified Cluster
- Adding Tags to a Cluster
- Deleting a Cluster Tag
- Adding or Deleting Cluster Tags in Batches
- Changing the Specifications of a Specified Node Type
- Scaling In a Cluster by Removing a Specific Node
- Scaling In Nodes of a Specific Type
- Downloading a Security Certificate
- Kibana Public Network Access
- Log Management
- Public Network Access
-
Snapshot Management
- (Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot
- Modifying Basic Configurations of a Cluster Snapshot
- Manually Creating a Snapshot
- Restoring a Snapshot
- Deleting a Snapshot
- Configuring the Automatic Snapshot Creation Policy
- Querying the Automatic Snapshot Creation Policy
- Querying a Snapshot List
- Disabling the Snapshot Function
- VPC Endpoint
- Parameter Configuration
- Common Parameters
- Change History
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Getting Started
- Permissions Management
- Creating and Accessing a Cluster
- Scaling In/Out a Cluster
- Importing Data to Elasticsearch
-
Managing Elasticsearch Clusters
- Cluster and Storage Capacity Statuses
- Introduction to the Cluster List
- Index Backup and Restoration
- Binding an Enterprise Project
- Restarting a Cluster
- Migrating Cluster Data
- Deleting a Cluster
- Managing Tags
- Public Network Access
- Managing Logs
- Managing Plugins
- Hot and Cold Data Storage
- Configuring Parameters
- Vector Retrieval
- Working with Kibana
- Elasticsearch SQL
- Enhanced Features
- Monitoring
- Auditing
-
FAQs
-
General Consulting
- What Are Regions and AZs?
- How Does CSS Ensure Data and Service Security?
- Which CSS Metrics Should I Focus On?
- What Storage Options Does CSS Provide?
- What Is the Maximum Storage Capacity of CSS?
- How Can I Manage CSS?
- What Can the Disk Space of a CSS Cluster Be Used For?
- How Do I Check the Numbers of Shards and Replicas in a Cluster on the CSS Console?
- What Data Compression Algorithms Does CSS Use?
-
Functions
- Can Elasticsearch Data Be Migrated Between VPCs?
- How Do I Migrate a CSS Cluster Across Regions?
- How Do I Configure the Threshold for CSS Slow Query Logs?
- How Do I Update the CSS Lifecycle Policy?
- How Do I Set the Numbers of Index Copies to 0 in Batches?
- Why All New Index Shards Are Allocated to the Same Node?
- How Do I Query Snapshot Information?
- Can I Upgrade a Cluster from an Earlier Version to a Later Version?
- Can I Restore a Deleted Cluster?
- Can I Modify the TLS Algorithm of an Elasticsearch Cluster?
- How Do I Set the search.max_buckets Parameter for an ES Cluster?
- Does the Value i of node.roles Indicate an Injest Node?
- How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster?
- Clusters in Security Mode
-
Resource Usage and Change
- How Do I Clear Expired Data to Release Storage Space?
- How Do I Configure a Two-Replica CSS Cluster?
- How Do I Delete Index Data?
- Can I Change the Number of Shards to Four with Two Replicas When There Is One Shard Set in the JSON File?
- What Are the Impacts If an Elasticsearch Cluster Has Too Many Shards?
- How Do I Set the Default Maximum Number of Records Displayed on a Page for an Elasticsearch Cluster
- Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data?
- How Do I Clear the Cache of a CSS Cluster?
- The Average Memory Usage of an Elasticsearch Cluster Reaches 98%
- Components
- Kibana
- Clusters
- Ports
-
General Consulting
- Change History
-
API Reference (Kuala Lumpur Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
Cluster Management
- Creating a cluster
- Querying the Cluster List
- Querying Cluster Details
- Deleting a Cluster
- Renaming a Cluster
- Changing the Password of a Cluster
- Restarting a Cluster
- Scaling Out a Cluster
- Adding Instances and Expanding Instance Storage Capacity
- Changing Specifications
- Obtaining the Instance Specifications List
- Querying All Tags
- Querying Tags of a Specified Cluster
- Adding Tags to a Cluster
- Deleting a Cluster Tag
- Adding or Deleting Cluster Tags in Batches
- Changing the Specifications of a Specified Node Type
- Scaling In a Cluster by Removing a Specific Node
- Scaling In Nodes of a Specific Type
- Downloading a Security Certificate
- Log Management
- Public Network Access
-
Snapshot Management
- (Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot
- Modifying Basic Configurations of a Cluster Snapshot
- Manually Creating a Snapshot
- Restoring a Snapshot
- Deleting a Snapshot
- Configuring the Automatic Snapshot Creation Policy
- Querying the Automatic Snapshot Creation Policy
- Querying a Snapshot List
- Disabling the Snapshot Function
- Parameter Configuration
- Permissions Policies and Supported Actions
- Common Parameters
- Change History
-
User Guide (Ankara Region)
- Product Overview
- Getting Started
- Permissions Management
- Viewing the Cluster Runtime Status and Storage Capacity Status
- Cluster List Overview
- Deploying a Cross-AZ Cluster
-
Elasticsearch
- Managing Elasticsearch Clusters
- Accessing an Elasticsearch Cluster
- Index Backup and Restoration
- Changing the Elasticsearch Cluster Form
- Configuring an Elasticsearch Cluster
- Managing Logs
- Managing Plugins
- Kibana Platform
- Enhanced Cluster Features
- Intelligent O&M
- Importing Data to Elasticsearch
- Monitoring
- Auditing
-
FAQs
-
General Consulting
- What Are Regions and AZs?
- How Does CSS Ensure Data and Service Security?
- Which CSS Metrics Should I Focus On?
- What Storage Options Does CSS Provide?
- What Is the Maximum Storage Capacity of CSS?
- Which Tools Can I Adopt to Use Cloud Search Service?
- What Can the Disk Space of a CSS Cluster Be Used For?
- How Do I Check the Numbers of Shards and Replicas in a Cluster on the CSS Console?
- What Data Compression Algorithms Does CSS Use?
-
Functions
- Can Elasticsearch Data Be Migrated Between VPCs?
- How Do I Migrate a CSS Cluster Across Regions?
- How Do I Configure the Threshold for CSS Slow Query Logs?
- How Do I Update the CSS Lifecycle Policy?
- How Do I Set the Numbers of Index Copies to 0 in Batches?
- Why All New Index Shards Are Allocated to the Same Node?
- How Do I Query Snapshot Information?
- Can I Upgrade a Cluster from an Earlier Version to a Later Version?
- Can I Restore a Deleted Cluster?
- Can I Modify the TLS Algorithm of an Elasticsearch Cluster?
- How Do I Set the search.max_buckets Parameter for an Elasticsearch Cluster?
- Does the Value i of node.roles Indicate an Ingest Node?
- How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster?
- Clusters in Security Mode
-
Resource Usage and Change
- How Do I Clear Expired Data to Release Storage Space?
- How Do I Configure a Two-Replica CSS Cluster?
- How Do I Delete Index Data?
- Can I Change the Number of Shards to Four with Two Replicas When There Is One Shard Set in the JSON File?
- What Are the Impacts If an Elasticsearch Cluster Has Too Many Shards?
- How Do I Set the Default Maximum Number of Records Displayed on a Page for an Elasticsearch Cluster
- Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data?
- How Do I Clear the Cache of a CSS Cluster?
- The Average Memory Usage of an Elasticsearch Cluster Reaches 98%
- Component Usage
- Kibana Usage
- Cluster Access
- Port Usage
-
General Consulting
- Change History
-
API Reference (Ankara Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
Cluster Management
- Creating a Cluster
- Querying the Cluster List
- Querying Cluster Details
- Deleting a Cluster
- Renaming a Cluster
- Changing the Password of a Cluster
- Restarting a Cluster
- Scaling Out a Cluster
- Adding Instances and Expanding Instance Storage Capacity
- Changing Specifications
- Obtaining the Instance Specifications List
- Querying All Tags
- Querying Tags of a Specified Cluster
- Adding Tags to a Cluster
- Deleting a Cluster Tag
- Adding or Deleting Cluster Tags in Batches
- Scaling In a Cluster by Removing a Specific Node
- Changing the Specifications of a Specified Node Type
- Scaling In Nodes of a Specific Type
- Downloading a Security Certificate
- Replacing a Node
- Changing the Security Mode
- Adding Dedicated Master and Client Nodes
- Changing the Security Group
- Creating a Cluster (V2)
- Restarting a Cluster (V2)
- Rolling Restart
- Kibana Public Network Access
- Log Management
- Public Network Access
-
Snapshot Management
- (Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot
- Modifying Basic Configurations of a Cluster Snapshot
- Manually Creating a Snapshot
- Restoring a Snapshot
- Deleting a Snapshot
- Configuring the Automatic Snapshot Creation Policy
- Querying the Automatic Snapshot Creation Policy
- Querying a Snapshot List
- Disabling the Snapshot Function
- Enabling Automatic Snapshot Creation
- Disabling Automatic Snapshot Creation
- Parameter Configuration
- Intelligent O&M
- Permissions Policies and Supported Actions
- Common Parameters
- Change History
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Index Backup and Restoration
You can back up index data in clusters. If data loss occurs or you want to retrieve data of a specified duration, you can restore the index data. Index backup is implemented by creating cluster snapshots. When creating a backup for the first time, you are advised to back up data of all indexes.
- Managing Automatic Snapshot Creation: Snapshots are automatically created at a specified time each day according to the rules you create. You can enable or disable the automatic snapshot creation function and set the automatic snapshot creation policy.
- Manually creating a snapshot: You can manually create a snapshot at any time to back up all data or data of specified indexes.
- Restoring data: You can use existing snapshots to restore the backup index data to a specified cluster.
- Deleting a snapshot: Delete snapshots you do not require and release resources.
- Before creating a snapshot, you need to perform basic configurations, including configuring the OBS bucket for storing snapshots, the snapshot backup path, and IAM agency used for security authentication.
- If there are available snapshots in the snapshot list when you configure the OBS bucket for storing cluster snapshots for the first time, you cannot change the bucket for snapshots that are subsequently created automatically or manually. Therefore, exercise caution when you configure the OBS bucket.
- If you want to change the OBS bucket where there are snapshots, do as follows: Disable the snapshot function, enable it, and specify a new OBS bucket. After you disable the snapshot function, you cannot use previously created snapshots to restore the cluster.
- If a cluster is in the Unavailable status, you can use the cluster snapshot function only to restore clusters and view existing snapshot information.
- During backup and restoration of a cluster, you can perform only certain operations, including scaling out, accessing Kibana, viewing metric, and deleting other snapshots of clusters. However, you cannot perform the following operations: restarting or deleting the cluster, deleting a snapshot that is in the Creating or Restoring status, and creating or restoring another snapshot. If a snapshot is being created or restored for a cluster, any automatic snapshot creation task initiated for the cluster will be canceled.
- The first snapshot of a cluster is a full snapshot, and subsequent snapshots are incremental snapshots. CSS snapshot files depend on each other.
- If you restore a CSS cluster snapshot to another cluster, indexes with the same name in the destination cluster will be overwritten. If the snapshot and the destination cluster use different shards, the indexes with the same name will not be overwritten.
Prerequisites
To use the function of creating or restoring snapshots, the account or IAM user logging in to the CSS management console must have both of the following permissions:
- Tenant Administrator for project OBS in region Global service
- Elasticsearch Administrator in the current region
Managing Automatic Snapshot Creation
- In the CSS navigation pane on the left, click Clusters.
- On the Clusters page that is displayed, click the name of the target cluster. In the navigation pane on the left, choose Cluster Snapshots.
- On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
- Enable the cluster snapshot function. OBS buckets and IAM agencies are automatically created to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. You can also click
on the right of Basic Configuration to edit the configuration.
Table 1 Cluster snapshot parameter Parameter
Description
OBS bucket
Select an OBS bucket for storing snapshots from the drop-down list box. You can also click Create Bucket on the right to create an OBS bucket.
The created or existing OBS bucket must meet the following requirements:
- Storage Class is Standard.
- CSS does not support encrypted OBS buckets. When selecting an OBS bucket for snapshot storage, do not enable bucket encryption.
Backup Path
Storage path of the snapshot in the OBS bucket.
The backup path configuration rules are as follows:- The backup path cannot contain the following characters: \:*?"<>|
- The backup path cannot start with a slash (/).
- The backup path cannot start or end with a period (.).
- The backup path cannot contain more than 1,023 characters.
IAM Agency
IAM agency authorized by the current account to CSS access or maintain data stored in the OBS bucket. You can also click Create IAM Agency on the right to create an IAM agency.
The created or existing IAM agency must meet the following requirements:
- Agency Type must be Cloud service.
- Set Cloud Service to Elasticsearch or CSS.
- The agency must have the Tenant Administrator permission for the OBS project in Global service.
- Enable the automatic snapshot creation function. The Configure Automatic Snapshot Creation dialog box is displayed. If the automatic snapshot creation function is enabled, you can click
on the right of Automatic Snapshot Creation to modify the snapshot policy.
- Snapshot Name Prefix: Enter a maximum of 32 characters starting with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. A snapshot name consists of a snapshot name prefix and a timestamp, for example, snapshot-2018022405925.
- Time Zone: indicates the time zone for the backup time. Specify Backup Start Time based on the time zone.
- Index: Enter an index name. You can select an index for backup. Use commas (,) to separate multiple indexes. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/? If you do not specify this parameter, data of all indexes in the cluster is backed up by default. You can use the asterisk (*) to back up data of certain indices. For example, if you enter index*, then data of indices with the name prefix of index will be backed up.
Run the GET /_cat/indices command in Kibana to query the names of all indexes in the cluster.
- Backup Start Time: indicates the time when the backup starts automatically every day. You can specify this parameter only in hours and not minutes, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select the backup time from the drop-down list box.
- Retention Period (days): indicates the duration when snapshots are retained in the OBS bucket, in days. The value ranges from 1 to 90. You can specify this parameter as required. The system automatically deletes snapshots that are retained over the specified retention period on the half hour.
- Click OK to save the snapshot policy.
Snapshots that are automatically created according to the snapshot policy are displayed in the snapshot list, along with manually created snapshots. You can distinguish them by the Snapshot Type setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots.
- (Optional) Disable the automatic snapshot creation function.
After you disable the automatic snapshot creation function, the system stops automatic creation of snapshots. If the system is creating a snapshot based on the automatic snapshot creation policy and the snapshot is not yet displayed in the snapshot list, you cannot disable the automatic snapshot creation function. In this case, if you click the button next to Automatic Snapshot Creation, a message is displayed, indicating that you cannot disable the function. You are advised to disable the function after the system completes automatic creation of the snapshot, and the created snapshot is displayed in the snapshot list.
When disabling the automatic snapshot creation function, you can choose whether to delete the snapshots that have been automatically created by selecting Delete automated snapshots in the displayed dialog box. By default, automatically created snapshots are not deleted.
- If you do not select Delete automated snapshots, automatically created snapshots are not deleted when you disable the automatic snapshot creation function. You can manually delete them later. For details, see Deleting a Snapshot. If you do not manually delete the automatically created snapshots and enable the automatic snapshot creation function again, then all snapshots with Snapshot Type set to Automated in the snapshot list of the cluster can only be automatically deleted by the system. Specifically, the system automatically deletes snapshots based on the snapshot policy configured when you enable the automatic snapshot creation function again. For example, if you set Retention Period (days) to 10, the system will automatically delete the snapshots that have been retained for more than 10 days.
- If you select Delete automated snapshots, all snapshots with Snapshot Type set to Automated in the snapshot list will be deleted when you disable the automatic snapshot creation function.
Manually Creating a Snapshot
- In the CSS navigation pane on the left, click Clusters.
- On the Clusters page that is displayed, click the name of the target cluster. In the navigation pane on the left, choose Cluster Snapshots.
- On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
- Enable the cluster snapshot function. OBS buckets and IAM agencies are automatically created to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. You can also click
on the right of Basic Configuration to edit the configuration.
Table 2 Cluster snapshot parameter Parameter
Description
OBS bucket
Select an OBS bucket for storing snapshots from the drop-down list box. You can also click Create Bucket on the right to create an OBS bucket.
The created or existing OBS bucket must meet the following requirements:
- Storage Class is Standard.
Backup Path
Storage path of the snapshot in the OBS bucket.
The backup path configuration rules are as follows:- The backup path cannot contain the following characters: \:*?"<>|
- The backup path cannot start with a slash (/).
- The backup path cannot start or end with a period (.).
- The backup path cannot contain more than 1,023 characters.
IAM Agency
IAM agency authorized by the current account to CSS access or maintain data stored in the OBS bucket. You can also click Create IAM Agency on the right to create an IAM agency.
The created or existing IAM agency must meet the following requirements:
- Agency Type must be Cloud service.
- Set Cloud Service to Elasticsearch or CSS.
- The agency must have the Tenant Administrator permission for the OBS project in Global service.
- After basic configurations are completed, click Create.
- Name indicates the name of the manually created snapshot, which can contain 4 to 64 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. For snapshots you create manually, you can specify the snapshot name. The system will not automatically add the time information to the snapshot name.
- Index: Enter an index name. You can select an index for backup. Use commas (,) to separate multiple indexes. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/? If you do not specify this parameter, data of all indexes in the cluster is backed up by default. You can use the asterisk (*) to back up data of certain indices. For example, if you enter index*, then data of indices with the name prefix of index will be backed up.
Run the GET /_cat/indices command in Kibana to query the names of all indexes in the cluster.
- Description: indicates the description of the created snapshot. The value contains 0 to 256 characters, and certain special characters (<>) are not allowed.
- Click OK.
After the snapshot is created, it will be displayed in the snapshot list. The status Available indicates that the snapshot is created successfully. All automatically and manually created snapshots are displayed in the snapshot list. You can distinguish them by the Snapshot Type setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots.
Restoring Data
You can use snapshots whose Snapshot Status is Available to restore cluster data. The stored snapshot data can be restored to other clusters.
Restoring data will overwrite current data in clusters. Therefore, exercise caution when restoring data.
- In the Snapshots area, locate the row that contains the snapshot you want to restore and click Restore in the Operation column.
- On the Restore page, set restoration parameters.
Index: Enter the name of the index you want to restore. If you do not specify any index name, data of all indexes will be restored. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed.
Rename Pattern: Enter a regular expression. Indexes that match the regular expression are restored. The default value index_(.+) indicates restoring data of all indices. The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed.
Rename Replacement: Enter the index renaming rule. The default value restored_index_$1 indicates that restored_ is added in front of the names of all restored indexes. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed. You can set Rename Replacement only if you have specified Rename Pattern.
Cluster: Select the cluster that you want to restore. You can select the current cluster or others. However, you can only restore the snapshot to clusters whose status is Available. If the status of the current cluster is Unavailable, you cannot restore the snapshot to the current cluster. If you choose to restore the snapshot to another cluster, ensure that the target cluster runs an Elasticsearch version that is not earlier than that of the current cluster. If you select another cluster and two or more indexes in the cluster have the same name, data of all indices with the same name as the name you specify will be overwritten. Therefore, exercise caution when you set the parameters.
- Click OK. If restoration succeeds, Task Status of the snapshot in the snapshot list will change to Restoration succeeded, and the index data is generated again according to the snapshot information.
Deleting a Snapshot
If you no longer need a snapshot, delete it to release storage resources. If the automatic snapshot creation function is enabled, snapshots that are automatically created cannot be deleted manually, and the system automatically deletes these snapshots on the half hour after the time specified by Retention Period (days). If you disable the automatic snapshot creation function while retaining the automated snapshots, then you can manually delete them later. If you do not manually delete the automatically created snapshots and enable the automatic snapshot creation function again, then all snapshots with Snapshot Type set to Automated in the snapshot list of the cluster can only be automatically deleted by the system.
After a snapshot is deleted, its data cannot be restored. Exercise caution when deleting a snapshot.
- In the snapshot list, locate the snapshot that you want to delete.
- Click Delete in the Operation column. In the dialog box that is displayed, confirm the snapshot information and click OK.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot