Overview

Tencent Cloud Elasticsearch Service (ES) is a highly available, scalable cloud-based Managed Elasticsearch Service built on the open-source search engine Elasticsearch by Tencent. It is deployed in a VPC and integrates components such as Elasticsearch and Kibana. By using Tencent Cloud ES, you can quickly deploy, easily manage, and scale your Elastic clusters on demand, simplifying complex Ops operations like cluster deployment and management. This enables you to quickly create services such as log analytics, anomaly monitoring, website search and navigation, enterprise search, and BI analysis.

This section introduces the ES API interfaces, which are all API 3.0 interfaces. You can call the API to operate Tencent Cloud ES, such as creating a cluster, updating an instance, managing indexes, and creating snapshots.
For ALL ES support API information, please refer to the API overview (https://www.tencentcloud.com/document/product/845/30620?from_cn_redirect=1).

Glossary

Common terminology for ES API interfaces is as listed in the table below:

Terminology | Description
|------|------|
| Cluster Instance | The basic management unit of ES, consisting of multiple node groups, providing distributed search and analysis capability. |
| Index | A document collection with similar features, which is the basic unit for storing and searching data in ES. |
| Snapshot | A complete data backup of a cluster at a certain moment, applicable to data recovery and migration. |

Usage Limits

For specific API parameter limits, refer to the parameter descriptions in each API document.

Getting Started with APIs

You can use the API Explorer Tool to make online API calls. This document bases on basic operations for cluster creation as an example, and the steps to call the API through the API Explorer Tool are as follows:

1. Go to the API Explorer tool page. For more information about API Explorer tool usage, see Using API Explorer.
2. Call CreateInstance to create an ES cluster instance.
3. Call DescribeInstances to query an ES cluster instance.
4. Call UpdateInstance to update the ES cluster instance.