tencent cloud

Elasticsearch Service

User Guide
Release Notes and Announcements
Release Notes
Product Announcements
Security Announcement
Product Introduction
Overview
Elasticsearch Version Support Notes
Features
Elastic Stack (X-Pack)
Strengths
Scenarios
Capabilities and Restrictions
Related Concepts
Purchase Guide
Billing Overview
Pricing
Elasticsearch Service Serverless Pricing
Notes on Arrears
ES Kernel Enhancement
Kernel Release Notes
Targeted Routing Optimization
Compression Algorithm Optimization
FST Off-Heap Memory Optimization
Getting Started
Evaluation of Cluster Specification and Capacity Configuration
Creating Clusters
Accessing Clusters
ES Serverless Guide
Service Overview
Basic Concepts
5-Minute Quick Experience
Quick Start
Access Control
Writing Data
Data Query
Index Management
Alarm Management
ES API References
Related Issues
Data Application Guide
Data Application Overview
Data Management
Elasticsearch Guide
Managing Clusters
Access Control
Multi-AZ Cluster Deployment
Cluster Scaling
Cluster Configuration
Plugin Configuration
Monitoring and Alarming
Log Query
Data Backup
Upgrade
Practical Tutorial
Data Migration and Sync
Use Case Construction
Index Configuration
SQL Support
Receiving Watcher Alerts via WeCom Bot
API Documentation
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
FAQs
Product
ES Cluster
Service Level Agreement
Glossary
New Version Introduction
Elasticsearch Service July 2020 Release
Elasticsearch Service February 2020 Release
Elasticsearch Service December 2019 Release

Request Structure

PDF
Focus Mode
Font Size
Last updated: 2025-11-13 20:48:15

1. Service Address

The API supports access from either a nearby region (at es.intl.tencentcloudapi.com) or a specified region (at es.ap-guangzhou.tencentcloudapi.com for Guangzhou, for example).

We recommend using the domain name to access the nearest server. When you call an API, the request is automatically resolved to a server in the region nearest to the location where the API is initiated. For example, when you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, the result is the same as that of specifying the region in the domain like "es.ap-guangzhou.tencentcloudapi.com".

Note: For latency-sensitive businesses, we recommend that you specify the region in the domain name.

Tencent Cloud currently supports the following regions:

Hosted region Domain name
Local access region (recommended, only for non-financial availability zones) es.intl.tencentcloudapi.com
South China (Guangzhou) es.ap-guangzhou.tencentcloudapi.com
East China (Shanghai) es.ap-shanghai.tencentcloudapi.com
East China (Nanjing) es.ap-nanjing.tencentcloudapi.com
North China (Beijing) es.ap-beijing.tencentcloudapi.com
Southwest China (Chengdu) es.ap-chengdu.tencentcloudapi.com
Southwest China (Chongqing) es.ap-chongqing.tencentcloudapi.com
Hong Kong, Macao, Taiwan (Hong Kong, China) es.ap-hongkong.tencentcloudapi.com
Southeast Asia (Singapore) es.ap-singapore.tencentcloudapi.com
Southeast Asia (Jakarta) es.ap-jakarta.tencentcloudapi.com
Southeast Asia (Bangkok) es.ap-bangkok.tencentcloudapi.com
Northeast Asia (Seoul) es.ap-seoul.tencentcloudapi.com
Northeast Asia (Tokyo) es.ap-tokyo.tencentcloudapi.com
U.S. East Coast (Virginia) es.na-ashburn.tencentcloudapi.com
U.S. West Coast (Silicon Valley) es.na-siliconvalley.tencentcloudapi.com
South America (São Paulo) es.sa-saopaulo.tencentcloudapi.com
Europe (Frankfurt) es.eu-frankfurt.tencentcloudapi.com

Note: As financial availability zones and non-financial availability zones are isolated, when accessing the services in a financial availability zone (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name of the financial availability zone, preferably in the same region as specified in Region.

Access region for financial availability zone Domain name for financial availability zone
East China (Shanghai Finance) es.ap-shanghai-fsi.tencentcloudapi.com
South China (Shenzhen Finance) es.ap-shenzhen-fsi.tencentcloudapi.com

2. Communications Protocol

All the Tencent Cloud APIs communicate via HTTPS, providing highly secure communication tunnels.

3. Request Methods

Supported HTTP request methods:

  • POST (recommended)
  • GET

The Content-Type types supported by POST requests:

  • application/json (recommended). The TC3-HMAC-SHA256 signature algorithm must be used.
  • application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature algorithm must be used.
  • multipart/form-data (only supported by certain APIs). You must use TC3-HMAC-SHA256 to calculate the signature.

The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or HmacSHA256 signature algorithm is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

4. Character Encoding

Only UTF-8 encoding is used.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback