- 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.
Upgrading the Version of an OpenSearch Cluster
OpenSearch clusters support both same-version upgrade and cross-version upgrade.
Scenarios
Upgrade scenarios
- During a same-version upgrade, kernel patches are updated for a cluster. The cluster is upgraded to the latest image of the current version to fix known issues or optimize performance. For example, if the cluster version is 1.3.6(1.3.6_24.3.3_0102), upon a same-version upgrade, the cluster will be upgraded to the latest image 1.3.6(1.3.6_24.3.4_0109) of version 1.3.6. (The version numbers used here are examples only.)
- Cross-version upgrade means to upgrade a cluster to the latest image of the target version to enhance functionality or incorporate versions. For example, if the cluster version is 1.3.6(1.3.6_24.3.3_1224), upon a cross-version upgrade, the cluster will be upgraded to the latest image 2.17.1(2.17.1_24.3.4_0109) of version 2.17.1. (The version numbers used here are examples only.)
Principle
The nodes in a cluster are upgraded one at a time to prevent service interruption. The upgrade process is as follows: Bring a node offline, migrate its data to another node, create a new node of the target version, and mount the NIC ports of the offline node to the new node to reuse the node IP address, then add the new node to the cluster. Upgrade the remaining nodes one at a time in the same way. If there is a large amount of data in a cluster, the upgrade duration depends on the data migration duration.
Process
- Perform the pre-upgrade check: Pre-Upgrade Check.
The pre-upgrade check is mostly automated. A few of the items need to be checked manually.
- Create a snapshot to back up the full index data: Manually Creating a Snapshot.
During upgrade configuration, you can choose to check whether the full index data has been backed up using snapshots. This helps to prevent data loss in case of an upgrade failure.
- Create an upgrade task and start the upgrade: Creating an Upgrade Task.
Constraints
- A maximum of 20 clusters can be upgraded at the same time. You are advised to perform the upgrade during off-peak hours.
- Clusters that have ongoing tasks cannot be upgraded.
- Once started, an upgrade task cannot be stopped until it succeeds or fails.
- During the upgrade, nodes are replaced one by one. Requests sent to a node that is being replaced may fail. In this case, you are advised to access the cluster through the VPC Endpoint service or a dedicated load balancer.
- During the upgrade, OpenSearch Dashboards and Cerebro will be rebuilt and become inaccessible. Different OpenSearch Dashboards versions are incompatible with each other. During the upgrade, you may fail to access OpenSearch Dashboards due to version incompatibility. It will become accessible again once the cluster is successfully upgraded.
Pre-Upgrade Check
To ensure a successful upgrade, you must check the items listed in the following table before performing an upgrade.
Check Item |
Check Method |
Description |
Normal Status |
---|---|---|---|
Cluster status |
System check |
After an upgrade task is started, the system automatically checks the cluster status. Clusters whose status is green or yellow can work properly and have no unallocated primary shards. |
The cluster status is Available. |
Node quantity |
System check |
During a cluster upgrade, the system automatically checks the number of nodes. To ensure service continuity, the total number of data nodes and cold data nodes in a cluster must be greater than or equal to 3. |
The total number of data nodes and cold data nodes in a cluster must be greater than or equal to 3. |
Disk capacity |
System check |
After an upgrade task is started, the system automatically checks the disk capacity. During the upgrade, nodes are brought offline one by one and then new nodes are created. Ensure that the disk capacity of all the remaining nodes can process all data of the node that has been brought offline. |
After a node is brought offline, the remaining nodes can contain all data of the cluster. |
Data backup |
System check |
Check whether the maximum number of primary and standby shards of indexes in a cluster can be allocated to the remaining data nodes and cold data nodes. Prevent backup allocation failures after a node is brought offline during the upgrade. |
Maximum number of primary and standby index shards plus 1 must be less than or equal to the total number of data nodes and cold data nodes before the upgrade. |
Data backup |
System check |
Before the upgrade, back up data to prevent data loss caused by upgrade faults. When submitting an upgrade task, you can determine whether to enable the system to check for the backup of all indexes. |
Check whether data has been backed up. |
Resources |
System check |
After an upgrade task is started, the system automatically checks resources. Resources will be created during the upgrade. Ensure that resources are available. |
Resources are available and sufficient. |
Custom plugins |
System and manual check |
Perform this check only when custom plugins are installed in the source cluster. If a cluster has a custom plugin, upload all plugin packages of the target version on the plugin management page before the upgrade. During the upgrade, install the custom plugin in the new nodes. Otherwise, the custom plugins will be lost after the cluster is successfully upgraded. After an upgrade task is started, the system automatically checks whether the custom plugin package has been uploaded, but you need to check whether the uploaded plugin package is correct. If the uploaded plugin package is incorrect or incompatible, the plugin package cannot be automatically installed during the upgrade. As a result, the upgrade task fails. To restore a cluster, you can terminate the upgrade task and restore the node that fails to be upgraded by performing Replacing Specified Nodes for an OpenSearch Cluster. After the upgrade is complete, the status of the custom plugin is reset to Uploaded. |
The plugin package of the cluster to be upgraded has been uploaded to the plugin list. |
Custom configurations |
System check |
During the upgrade, the system automatically synchronizes the content of the cluster configuration file opensearch.yml. |
Clusters' custom configurations are not lost after the upgrade. |
Non-standard operations |
Manual check |
Check whether non-standard operations have been performed in the cluster. Non-standard operations refer to manual operations that are not recorded. These operations cannot be automatically passed on during the upgrade, for example, modification of the opensearch_dashboards.yml configuration file, system settings, and return routes. |
Some non-standard operations are compatible. For example, the modification of a security plugin can be retained through metadata, and the modification of system configuration can be retained using images. Some non-standard operations, such as the modification of the opensearch_dashboards.yml file, cannot be retained, and you must back up the file in advance. |
Compatibility check |
System and manual check |
After a cross-version upgrade task is started, the system automatically checks whether the source and target versions have incompatible configurations. If a custom plugin is installed for a cluster, the version compatibility of the custom plugin needs to be manually checked. |
Configurations before and after the cross-version upgrade are compatible. |
Check Cluster Loads |
System and manual check |
If the cluster is heavily loaded, there is a high probability that the upgrade will get stuck or fail. You are advised to check the cluster load before the upgrade and perform the upgrade only during off-peak hours. You can also choose to check the cluster load while configuring upgrade information. |
|
Creating an Upgrade Task
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters. On the cluster list page that is displayed, click the name of a cluster.
- On the displayed basic cluster information page, click Version Upgrade.
- On the displayed page, set upgrade parameters.
Table 2 Upgrade parameters Parameter
Description
Upgrade Type
- Same-version upgrade: upgrade kernel patches to the latest images within the current cluster version.
- Cross-version upgrade: upgrade a cluster to the latest image of the target version.
Target Image
Image of the target version. After you select an image, the image name and target version details are displayed below.
The supported target versions are displayed in the drop-down list of Target Image. If no target image is available, possible causes are as follows:
- The current cluster is of the latest version.
- The current cluster is created before 2023 and has vector indexes.
- The new version images have not been added at the current region.
- The current cluster does not support the upgrade type you have selected.
Agency
When a node is deleted, NICs are released. This means you need to have VPC permissions. Select an IAM agency to grant the current account the permission to access and use VPC.
- If you are configuring an agency for the first time, click Automatically Create IAM Agency to create css-upgrade-agency.
- If there is an IAM agency automatically created earlier, you can click One-click authorization to have the permissions associated with the VPC Administrator role or the VPC FullAccess system policy deleted automatically, and have the following custom policies added automatically instead to implement more refined permissions control.
"vpc:subnets:get", "vpc:ports:*"
- To use Automatically Create IAM Agency and One-click authorization, the following minimum permissions are required:
"iam:agencies:listAgencies", "iam:roles:listRoles", "iam:agencies:getAgency", "iam:agencies:createAgency", "iam:permissions:listRolesForAgency", "iam:permissions:grantRoleToAgency", "iam:permissions:listRolesForAgencyOnProject", "iam:permissions:revokeRoleFromAgency", "iam:roles:createRole"
- To use an IAM agency, the following minimum permissions are required:
"iam:agencies:listAgencies", "iam:agencies:getAgency", "iam:permissions:listRolesForAgencyOnProject", "iam:permissions:listRolesForAgency"
- After setting the parameters, click Submit. Determine whether to enable Check full index snapshot and Perform cluster load detection and click OK.
If a cluster is overloaded, the upgrade task may suspend or fail. Enabling Cluster load detection can effectively avoid failures.
If any of the following situations occurs during the detection, wait or reduce the load. If you urgently need to upgrade the version and you have understood the upgrade failure risks, you can disable the Cluster load detection function. The cluster load check items are as follows:
- nodes.thread_pool.search.queue < 1000: Check whether the maximum number of search queues is less than 1000.
- nodes.thread_pool.write.queue < 200: Check whether the maximum number of write queues is less than 200.
- nodes.process.cpu.percent < 90: Check whether the maximum CPU usage is less than 90%.
- nodes.os.cpu.load_average/Number of CPU cores < 80%: Check whether the ratio of the maximum load to the number of CPU cores is less than 80%.
- View the upgrade task in the task list. If the task status is Running, you can expand the task list and click View Progress to view the upgrade progress.
If the task status is Failed, you can retry or terminate the task.
- Retry the task: Click Retry in the Operation column.
- Terminate the task: Click Terminate in the Operation column.
NOTICE:
- Same version upgrade: If the upgrade task status is Failed, you can terminate the upgrade task.
- Cross version upgrade: You can stop an upgrade task only when the task status is Failed and no node has been upgraded.
After an upgrade task is terminated, the Task Status of the cluster is rolled back to the status before the upgrade, and other tasks in the cluster are not affected.
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