- 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.
About Vector Search
Unstructured data, such as images, videos, and language corpora, is converted into vectors, which are searched based on similarity using either an exact or approximate nearest neighbors algorithm.
How It Works
Vector search works in a way similar to traditional search. To improve vector search performance, we need to:
- Narrow down the matched scope
Similar to traditional text search, vector search use indexes to accelerate the search instead of going through all data. Traditional text search uses inverted indexes to filter out irrelevant documents, whereas vector search creates indexes for vectors to bypass irrelevant vectors, narrowing down the search scope.
- Reduce the complexity of calculating a single vector
The vector search method can quantize and approximate high dimensional vectors first. By doing this, you can acquire a smaller and more relevant data set. Then more sophisticated algorithms are applied to this smaller data set to perform computation and sorting. This way, complex computation is performed on only part of the vectors, and efficiency is improved.
Vector search means to retrieve the k-nearest neighbors (KNN) to the query vector in a given vector data set by using a specific measurement method. Generally, CSS only focuses on Approximate Nearest Neighbor (ANN), because a KNN search requires excessive computational resources.
Vector Search in CSS
The CSS vector search engine integrates a variety of vector indexes, such as brute-force search, Hierarchical Navigable Small World (HNSW) graphs, product quantization, and IVF-HNSW. It also supports multiple similarity calculation methods, such as Euclidean, inner product, cosine, and Hamming. The recall rate and retrieval performance of the engine are better than those of open-source engines. It can meet the requirements for high performance, high precision, low costs, and multi-modal computation.
The search engine also supports all the capabilities of the native Elasticsearch, including distribution, multi-replica, error recovery, snapshot, and permission control. The engine is compatible with the native Elasticsearch ecosystem, including the cluster monitoring tool Cerebro, the visualization tool Kibana, and the real-time data ingestion tool Logstash. Several client languages, such as Python, Java, Go, and C++, are supported.
Constraints
- Only Elasticsearch 7.6.2, Elasticsearch 7.10.2, and OpenSearch 1.3.6 clusters support the vector search engine of CSS.
- The vector search plug-in performs in-memory computing and requires more memory than common indexes do. You are advised to use memory-optimized compute specifications.
- To use the vector search plug-in of CSS, the memory capacity of a data node or cold data node must be greater than 16 GB. To enable the vector search plug-in, contact technical support.
Cluster Node Specifications Selection for Vector Search
Off-heap memory is used for index construction and query in vector search. Therefore, the required cluster capacity is related to the index type and off-heap memory size. You can estimate the off-heap memory required by full indexing to select the appropriate cluster specifications. Due to high memory usage of vector search, CSS disables the vector search plug-in by default for clusters whose memory is 8 GB or less.
- GRAPH Index
mem_needs = (dim x dim_size + neighbros x 4) x num + delta
NOTE:
If you need to update indexes in real time, consider the off-heap memory overhead required for vector index construction and automatic merge. The actual size of required mem_needs is at least 1.5 to 2 times of the original estimation.
- PQ Index
mem_needs = frag_num x frag_size x num + delta
- FALT and IVF Indexes
mem_needs = dim x dim_size x num + delta
Parameter |
Description |
---|---|
dim |
Vector dimensionality |
neighbors |
Number of neighbors of a graph node. The default value is 64. |
dim_size |
Number of bytes required by each dimension. The default value is four bytes in the float type. |
num |
Total number of vectors |
delta |
Metadata size. This parameter can be left blank. |
frag_num |
Number of vector segments during quantization and coding. If this parameter is not specified when an index is created, the value is determined by vector dimensionality dim. if dim <= 256: frag_num = dim / 4 elif dim <= 512: frag_num = dim / 8 else : frag_num = 64 |
frag_size |
Size of the center point during quantization and coding. The default value is 1. |
These calculation methods can estimate the size of off-heap memory required by a complete vector index. To determine cluster specifications, you also need to consider the heap memory overhead of each node.
Heap memory allocation policy: The size of the heap memory of each node is half of the node physical memory, and the maximum size is 31 GB.
For example, if you create a Graph index for the SIFT10M dataset, with dim set to 128, dim_size to 4, neighbors to the default value 64, and num to 10 million, the off-heap memory required by the Graph index is around 7.5 GB. Calculation formula: mem_needs = (128 x 4 + 64 x 4) x 10000000 ≈ 7.5.
Considering the overhead of heap memory, a single server with 8 vCPUs and 16 GB memory is recommended. If real-time write or update is required, you need to apply for larger memory.
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