Docs
EN
Docs
Console
Sign in
Cloud Search Service
Document
Cloud Search Service
Cloud Search Service
Document
What's new
Release notes
Overview
What is Cloud Search
Use cases
Terms
Product specifications
Cloud Search kernel
Kernel version release notes
Kernel enhancement
Bulk directional routing
Adaptive write optimization
Controllable latency queue
Multi-AZ replica traffic balancing
Using the DiskANN vector engine
Region and availability zone
Product Billing
Billing overview
Billing Methods
Pay-as-you-go
Subscription
Changing billing method
Billable items
Instance renewal
Overdue payments
Costs for unsubscription or specification changing
Taxes and invoices
Getting Started
Before Use
Instance resource estimation
Resource calculator
Cross-service Authorization
Create an instance
Accessing an Instance
Accessing an instance by using Kibana
Accessing an instance by using the API
Accessing an instance by using a client
Volumes base bandwidth reference
User Guide
Instance Index management
Instance Lifecycle Management
Create an instance
Viewing instance details
Restart instance or node
Delete Instance
Customizing column fields of instance list
Exporting instance data
Update instance patch version
Changing Instance Specifications
Upgrade an instance
Downgrading instance specifications
Shrink data node
Adding dedicated master nodes
Adding availability zone
Modifying Instance Configurations
Modifying the maintenance window
Setting deletion protection for an instance
Configuring instance tag
Resetting an access password
Changing the transfer protocol of an instance
Modifying network configuration
Optimization solution for network change
Accessing Instances
Access an instance
Configure instance public network access
Configure instance public network IP allowlist
Configure instance private network IP allowlist
Configure instance private network address public network resolution
Visualization Tool
Kibana/Dashboards
Log on to Kibana/Dashboards
Configure Kibana/Dashboards public network access
Configuring a public IP allowlist for the visualization tool
Configuring a private IP allowlist for the visualization tool
Configuring Internet DNS Lookup for the visualization tool
Modifying Kibana/Dashboards parameters
FAQs
Cerebro
Enable Cerebro
Log on to Cerebro
Configure Cerebro public network access
Configure Cerebro public network IP allowlist
Configure Cerebro private network IP allowlist
Configure Cerebro private network address public network resolution
Plugin Management
Built-in Plugins
View system built-in plugins
Managing built-in plugins
User-defined Plugins
Uploading user-defined plugins
Installing user-defined plugins
Uninstalling user-defined plugins
Deleting user-defined plugins
Troubleshooting custom plugin installation issues
Use the IK analyzer plugin
Visual configuration of IK tokenization
Upload IK tokenizer dictionary files
Experiencing IK tokenization capabilities
Use the jieba tokenization plugin
Visual configuration of Jieba tokenization
Uploading Jieba dictionary file
Plugin Instruction
Using the Ngram-Type plugin for fuzzy queries
Byte-codec plugin instructions
Byte-throttler rate limiting plugin instructions
Enhancements plugin instructions
Wildcard Type plugin instructions
Remote Inference plugin instructions
Backup Management
Backup overview
Automatic snapshot creation
manual snapshot creation
Viewing snapshot details
Recover data using snapshot
Deleting snapshots
Viewing the snapshot bucket
Parameter Configuration
View system parameters
Configuring system parameters
Search Management
Configuring Synonym
Configuring synonym terms via GUI
Managing synonym files
Synonym test
Loading synonym files dynamically via plugin
Configuring Analyzer
Configuring analyzer terms via GUI
Managing dictionary files
Testing the effect of synonym terms
Data Refresh
Executing data refresh
Canceling data refresh tasks
Category Prediction Intervention
Installing category prediction plugin
Configuring category prediction terms
Experience category prediction
Custom file management
Observability
View monitoring data
Monitoring and Alarms
Configure alarms with one click
Recommended alert rules
Configuring an alarm policy
Log Management
Querying logs
Cluster IP tracing
Security Auditing
Control panel audit log
Data plane auditing
Enable data plane auditing
Query data plane auditing logs
Customizing and exporting audit logs
Configuring audit log collection parameters
Managing the lifecycle of audit log indices
Operation and Maintenance
Intelligent Operation and Maintenance
Intelligent O&M Overview
Enable intelligent O&M
Performing a diagnostic on an instance
Viewing instance health overview
Viewing diagnosis reports
Modifying the automatic diagnostic time
Disabling Intelligent O&M feature
Command-based O&M
Overview of O&M commands
Querying the cluster health status
Managing indices
Managing indices
Managing index templates
Managing lifecycle policies
Dev Tools
Cerebro management
Create Cerebro
View Cerebro details
Access Cerebro
Manage Cerebro
Configure Cerebro public network access
Configure Cerebro public network IP allowlist
Configure Cerebro private network IP allowlist
Configure Cerebro private network address public network resolution
Snapshot Management
Snapshot management overview
Creating snapshots automatically
manual snapshot creation
Dump snapshots to TOS
Viewing snapshot details
Recover data using snapshot
Deleting a snapshot file
Stopping snapshot production
AI search
Manage AI search
Create an AI search service
Modify AI search
View AI search
Release AI Search
Configure AI search Virtual Private Cloud
Configure the private IP whitelist for AI Search
Configure AI search public network access
Configure the public IP whitelist for AI search
Configure public network resolution for AI Search private addresses
Manage models
Create a custom model
Edit model
Delete a model
View custom models
View public models
View Doubao large models
Manage scenario development
Instance authorization
No-code scenario
RAG scenario
Create scene
Start a scenario
Scenario development
Data management
Edit a scene
Stop a scenario
Delete scene
View RAG scenarios
Hybrid search scenario
Create a scenario
Start a scene
Scenario development
Image and text search scenario
Create a scenario
Scenario development
Start a scenario
Low-code scenario
Create a scenario
Configure scenario resources
Start a scene
Scenario development
Index management
Instance authorization
Create index
View index
Edit an index
Turn index off or on
Delete an index
Manage search configurations
Manage inference services
Create an inference service
Start an inference service
View inference service information
Edit inference service
Stop an inference service
Delete an inference service
Call model
Call an embedding model
Text Embedding model use cases
Manage AI tasks
Create a task
Start a task
View task configuration
Edit task
Delete a task
Developing and testing interactive tasks
Generating an inference service from an interactive task
Generate a data augmentation task from an interactive task
Alerts and monitoring
View AI search monitoring data
Configure alert policies for AI search
Manage API keys
Create API Key
View API key
Delete an API key
Task Center
Viewing task progress
Read log service data and write to Cloud Search
Read Message Queue for Kafka data into Cloud Search
Logstash User Guide
What is Logstash
Instance management
Create a Logstash instance
View Logstash instances
View Logstash instance information
Upgrade a Logstash instance
Restart a Logstash instance
Cancel a subscription Logstash instance
Convert a pay-as-you-go Logstash instance to subscription
Delete a pay-as-you-go Logstash instance
Instance configuration
Configure YAML files
Configure extension files
Pipeline management
Pipeline introduction
Standard pipeline
Metadata migration pipeline
Pipeline status
Create a pipeline
Manage pipelines
Use the debugging feature
Comparison feature of metadata migration pipelines
Monitoring and Logs
View monitoring
Configure alerts
Query logs
Plugin introduction
Differences Between Plugins in Elasticsearch and OpenSearch
Best Practices
Connecting to a cluster
Connecting to a cluster using Kibana
Connecting to a cluster using cURL
Connect to an instance and access Kibana/Dashboards using an HTTPS certificate
Connecting to a Cluster Using Java
Connecting to a cluster using Java
Connect to an OpenSearch instance by using Java
Switch Elasticsearch Java SDK to OpenSearch Java SDK
Connecting to a Cluster Using Python
Connecting to a cluster using Python
Connect to an OpenSearch instance using Python
Switch from Elasticsearch Python SDK to OpenSearch Python SDK
Application building
Build a text-image retrieval application based on cloud search service + Doubao-1.5-pro visual understanding model
Build image and text search applications based on Cloud Search services (image-to-image search, text-to-image search)
Practice of learning to rank based on Cloud Search
Practice of hybrid search and reranking based on Cloud Search
Use the Volcano Cloud Search plugin in Cozy
Cloud Search hybrid retrieval + rerank operation example (using Doubao embedding model)
Volcano Engine Cloud Search skill user guide
Time series data management
Manage time-series data using Data Streams and ISM
Searchable snapshot
Searchable snapshot overview
Manually create searchable snapshots
Create searchable snapshots through ISM
Optimize search results
Tuning the console UI
Tuning Pipeline and Query templates
Rerank tuning
How to manage the active shard distribution in balanced Cloud Search service instances
Vector retrieval
CloudSearch-based distributed vector databases
Cloud Search hybrid retrieval technology: Principle analysis and cloud practices
Using the DiskANN vector engine
FaaS Agent experience
About Long-term Memory Agent
Deploy a Long-term Memory Agent application with one click
Read object storage data and write to Cloud Search
FAQ
FAQs
Terms of Service
Service-Specific Terms for BytePlus Cloud Search
BytePlus Cloud Search Service Level Agreement
Terms of data migration
API Reference
List of API actions
How to invoke the API
Request structure
Common parameters
Signature mechanism
Return result
Resource management
DescribeZones - Get the list of availability zones
Instance query
DescribeInstance - View instance details
DescribeInstances - Query Instances
DescribeInstanceNodes - Query the list of instance nodes
DescribeInstancePlugins - Query instance plugins
DescribeNodeAvailableSpecs - Query available node configurations
DescribeNodeAvailableSpecsV2
Instance Management
CreateInstance
CreateInstanceInOneStep
RenameInstance
ReleaseInstance
RestartInstance
RestartNode
ResetAdminPassword
ModifyMaintenanceSetting
ModifyDeletionProtection
ModifyNodeSpecInOneStep
ModifyChargeCode
DescribeScenarios
Observability
ListLogs
Use Logstash to migrate data across clusters
Synchronizing Kafka Data to Cloud Search via Function Service
Use Volcano Engine TOS for cross-region data migration
Configure public network access using SNAT
Migrate data across clouds using Volcengine TOS
Documentation
Cloud Search Service
Product Billing
Instance renewal
Copy page
Download PDF
Product Billing
Instance renewal
Copy page
Download PDF
Instance renewal
Last updated: 2026.02.06 15:16:40