- User Guide
- Release Notes
- Product Introduction
- Purchase Guide
- ES Kernel Enhancement
- Getting Started
- ES Serverless Guide
- Data Application Guide
- Elasticsearch Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Instance APIs
- CreateIndex
- DescribeInstanceLogs
- UpdateInstance
- RestartInstance
- DescribeInstances
- DeleteInstance
- CreateInstance
- DescribeInstanceOperations
- UpgradeLicense
- UpgradeInstance
- UpdatePlugins
- RestartNodes
- RestartKibana
- UpdateRequestTargetNodeTypes
- GetRequestTargetNodeTypes
- DescribeViews
- UpdateDictionaries
- UpdateIndex
- DescribeIndexMeta
- DescribeIndexList
- DeleteIndex
- Making API Requests
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Glossary
- New Version Introduction
- User Guide
- Release Notes
- Product Introduction
- Purchase Guide
- ES Kernel Enhancement
- Getting Started
- ES Serverless Guide
- Data Application Guide
- Elasticsearch Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Instance APIs
- CreateIndex
- DescribeInstanceLogs
- UpdateInstance
- RestartInstance
- DescribeInstances
- DeleteInstance
- CreateInstance
- DescribeInstanceOperations
- UpgradeLicense
- UpgradeInstance
- UpdatePlugins
- RestartNodes
- RestartKibana
- UpdateRequestTargetNodeTypes
- GetRequestTargetNodeTypes
- DescribeViews
- UpdateDictionaries
- UpdateIndex
- DescribeIndexMeta
- DescribeIndexList
- DeleteIndex
- Making API Requests
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Glossary
- New Version Introduction
1. Service Address
The API supports access from either a nearby region (at es.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.tencentcloudapi.com |
| South China (Guangzhou) | es.ap-guangzhou.tencentcloudapi.com |
| East China (Shanghai) | es.ap-shanghai.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 (Bangkok) | es.ap-bangkok.tencentcloudapi.com |
| South Asia (Mumbai) | es.ap-mumbai.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 |
| 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.
Yes
No
Was this page helpful?