- 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.
Creating Vector Indexes in an OpenSearch Cluster
To create a vector index, perform the following steps:
- (Optional) Preparations: Configure advanced cluster settings based on service needs.
- (Optional) Pre-Building and Registering a Center Point Vector: If index algorithms IVF_GRAPH and IVF_GRAPH_PQ are selected when creating a vector index, pre-build and register a center point vector.
- Creating a Vector Index: Create a vector index based on service needs.
- Importing Vector Data: Import vector data to the cluster.
- Using Vector Indexes for Data Search in an Elasticsearch Cluster: Perform a vector search.
Prerequisites
You have created a cluster by referring to Cluster Node Specifications Selection for Vector Search. The cluster must be an Elasticsearch cluster of version 7.6.2 or 7.10.2, or an OpenSearch cluster of version 1.3.6.
(Optional) Preparations
Before creating a vector index, configure advanced settings for the cluster based on service needs.
- When importing data offline, you are advised to set refresh_interval of indexes to -1 to disable automatic index refreshing and thus improve batch write performance.
- You are advised to set number_of_replicas to 0. After the offline data import is complete, you can modify the parameter value again as needed.
- Table 1 describes the other advanced settings.
Table 1 Parameters for advanced cluster settings Parameter
Description
native.cache.circuit_breaker.enabled
Whether to enable the circuit breaker for off-heap memory.
Default value: true
native.cache.circuit_breaker.cpu.limit
Upper limit of off-heap memory usage of the vector index.
For example, if the overall memory of a host is 128 GB and the heap memory occupies 31 GB, the default upper limit of the off-heap memory usage is 43.65 GB, that is, (128 - 31) x 45%. If the off-heap memory usage exceeds its upper limit, the circuit breaker will be triggered.
Default value: 45%
native.cache.expiry.enabled
Whether to enable the cache expiration policy. If this parameter is set to true, some cache items that have not been accessed for a long time will be cleared.
Value: true or false.
Default value: false
native.cache.expiry.time
Expiration time.
Default value: 24h
native.vector.index_threads
Number of threads used for creating underlying indexes. Each shard uses multiple threads. Set a relatively small value to avoid resource preemption caused by the build queries of too many threads.
Default value: 4
(Optional) Pre-Building and Registering a Center Point Vector
If index algorithms IVF_GRAPH and IVF_GRAPH_PQ are selected when creating a vector index, you need to pre-build and register a center point vector.
The vector index acceleration algorithms IVF_GRAPH and IVF_GRAPH_PQ are suitable for ultra-large-scale computing. These two algorithms allow you to narrow down the query scope by dividing a vector space into subspaces through clustering or random sampling. Before pre-build, you need to obtain all center point vectors by clustering or random sampling. Center point vectors are pre-built into the GRAPH or GRAPH_PQ index and register them with the Elasticsearch cluster. All nodes in the cluster can share this index file. Reuse of the center index among shards can effectively reduce the training overhead and the number of center index queries, improving the write and query performance.
- On the Clusters page, locate the target cluster, and click Access Kibana in the Operation column.
- Click Dev Tools in the navigation tree on the left.
- Create a center point index table.
- For example, if the created index is named my_dict, number_of_shards of the index must be set to 1. Otherwise, the index cannot be registered.
- If you want to use the IVF_GRAPH index, set algorithm of the center point index to GRAPH.
- If you want to use the IVF_GRAPH_PQ index, set algorithm of the center point index to GRAPH_PQ.
PUT my_dict { "settings": { "index": { "vector": true }, "number_of_shards": 1, "number_of_replicas": 0 }, "mappings": { "properties": { "my_vector": { "type": "vector", "dimension": 2, "indexing": true, "algorithm": "GRAPH", "metric": "euclidean" } } } }
- Write the center point vector to the created index.
Write the center point vector obtained through sampling or clustering into the created my_dict index. For details, see Importing Vector Data.
- Call the registration API.
Register the created my_dict index with a Dict object with a globally unique identifier name (dict_name).
PUT _vector/register/my_dict { "dict_name": "my_dict" }
- Create an IVF_GRAPH or IVF_GRAPH_PQ index.
You do not need to specify the dimension or metric information. Simply specify the registered dictionary name.
PUT my_index { "settings": { "index": { "vector": true, "sort.field": "my_vector.centroid" # Set the centroid subfield of each vector field as a sorting field. } }, "mappings": { "properties": { "my_vector": { "type": "vector", "indexing": true, "algorithm": "IVF_GRAPH", "dict_name": "my_dict", "offload_ivf": true } } } }
Table 2 Field mappings parameters Parameter
Description
dict_name
Specifies the name of the depended central point index. The vector dimensions and metrics of the index are the same as those of the Dict index.
offload_ivf
Unloads the IVF inverted index implemented by the underlying index to Elasticsearch. The reduces the use of non-heap memory and the overhead of write and merge operations. You are advised to set this parameter to true.
Value: true or false.
Default value: false
Creating a Vector Index
- Log in to the CSS management console.
- Choose Clusters in the navigation pane. On the Clusters page, locate the target cluster and click Access Kibana in the Operation column.
- Click Dev Tools in the navigation tree on the left and run the following command to create a vector index.
Create an index named my_index that contains a vector field my_vector and a text field my_label. The vector field creates the graph index and uses Euclidean distance to measure similarity.
PUT my_index { "settings": { "index": { "vector": true } }, "mappings": { "properties": { "my_vector": { "type": "vector", "dimension": 2, "indexing": true, "algorithm": "GRAPH", "metric": "euclidean" }, "my_label": { "type": "keyword" } } } }
Table 3 Parameters for creating an index Type
Parameter
Description
Index settings parameters
vector
To use a vector index, set this parameter to true.
Field mappings parameters
type
Field type, for example, vector.
dimension
Vector dimensionality. Value range: [1, 4096]
indexing
Whether to enable vector index acceleration.
The value can be:- false: disables vector index acceleration. If this parameter is set to false, vector data is written only to docvalues, and only ScriptScore and Rescore can be used for vector query.
- true: enables vector index acceleration. If this parameter is set to true, an extra vector index is created. The index algorithm is specified by the algorithm field and VectorQuery can be used for data query.
Default value: false
algorithm
Index algorithm. This parameter is valid only when indexing is set to true.
The value can be:- FLAT: brute-force algorithm that calculates the distance between the target vector and all vectors in sequence. The algorithm relies on sheer computing power and its recall rate reaches 100%. You can use this algorithm if you require high recall accuracy.
- GRAPH: Hierarchical Navigable Small Worlds (HNSW) algorithm for graph indexes. This algorithm is mainly used in scenarios where high performance and precision are required and the data records of a single shard is fewer than 10 million.
- GRAPH_PQ: combination of the HNSW algorithm and the PQ algorithm. The PQ algorithm reduces the storage overhead of original vectors, so that HNSW can easily search for data among hundreds of millions of records.
- IVF_GRAPH: combination of IVF and HNSW. The entire space is divided into multiple cluster centroids, which makes search much faster but slightly inaccurate. You can use this algorithm if you require high performance when searching for data among hundreds of millions of records.
- IVF_GRAPH_PQ: combination of the PQ algorithm with the IVF or HNSW algorithm to further improve the system capacity and reduce the system overhead. This algorithm is applicable to scenarios where there are more than 1 billion files in shards and high retrieval performance is required.
Default value: GRAPHNOTE:
If IVF_GRAPH or IVF_GRAPH_PQ is specified, you need to pre-build and register a central point index. For details, see (Optional) Pre-Building and Registering a Center Point Vector.
Other optional parameters
If Indexing is set to true, CSS provides optional parameters for vector search that you can configure to achieve higher query performance or precision. For more information, see Table 4.
metric
Method of calculating the distance between vectors.
The value can be:
- euclidean: Euclidean distance
- inner_product: inner product distance
- cosine: cosine distance
- hamming: Hamming distance, which can be used only when dim_type is set to binary.
Default value: euclidean
dim_type
Type of the vector dimension value.
The value can be binary and float (default).
Table 4 Optional parameters Type
Parameter
Description
Graph index configuration parameters
neighbors
Number of neighbors of each vector in a graph index. The default value is 64. A larger value indicates higher query precision. A larger index results in a slower build and query speed.
Value range: [10, 255]
shrink
Cropping coefficient during HNSW build. The default value is 1.0f.
Value range: (0.1, 10)
scaling
Scaling ratio of the upper-layer graph nodes during HNSW build. The default value is 50.
Value range: (0, 128]
efc
Queue size of the neighboring node during HNSW build. The default value is 200. A larger value indicates a higher precision and slower build speed.
Value range: (0, 100000]
max_scan_num
Maximum number of nodes that can be scanned. The default value is 10000. A larger value indicates a higher precision and slower indexing speed.
Value range: (0, 1000000]
PQ index configuration parameters
centroid_num
Number of cluster centroids of each fragment. The default value is 255.
Value range: (0, 65535]
fragment_num
Number of fragments. The default value is 0. The plug-in automatically sets the number of fragments based on the vector length.
Value range: [0, 4096]
Importing Vector Data
Run the following command to import vector data. When writing vector data to the my_index index, you need to specify the vector field name and vector data.
- If the input vector data is an array of floating-point numbers separated by commas (,):
POST my_index/_doc { "my_vector": [1.0, 2.0] }
- If the input vector data is a Base64 string encoded using little endian:
- To write a large amount of data, bulk operations are recommended.
POST my_index/_bulk {"index": {}} {"my_vector": [1.0, 2.0], "my_label": "red"} {"index": {}} {"my_vector": [2.0, 2.0], "my_label": "green"} {"index": {}} {"my_vector": [2.0, 3.0], "my_label": "red"}
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