Overview of Access Methods

Last updated: 2020-02-26 22:35:45


Restful API

Elasticsearch provides RESTful APIs that have comprehensive and powerful features to interact with clusters. These APIs can be used to:

  • View the health status and statistics of clusters, nodes, and indices.
  • Manage clusters, nodes, indexed data, and metadata and adjust cluster configuration.
  • Perform (Create, Read, Update, and Delete) CRUD operations and various types of queries on indexed data, such as full-text search, filtering, aggregation, and sorting.

For more information about these configuration items, see Elasticsearch Official Documentation.


  • You can call a REST API to access a cluster using any client that allows you to send HTTP/REST calls, such as curl and Kibana Dev Tool.
  • Elasticsearch provides clients in a variety of programming languages, such as Java and Python, to meet the needs of different developers. For more information, see Elasticsearch Clients.
  • Starting from Elasticsearch 5.6.0, a new official Java client has been released: the Java High Level REST Client. This client can be used to perform search, index, delete, update, and bulk operations using the same core Java classes as the Transport Client does. It is actually designed to replace the Transport Client. For more information, see Java High Level REST Client.

In terms of version compatibility, you are recommended to choose the client version that is compatible with the server version. For more information, see Compatibility. Currently, ES is available in multiple Elasticsearch versions, so be sure to select a compatible client version.

Access authentication

If you select the Platinum Edition that comes with X-Pack plugin, user authentication will be enabled for Elasticsearch clusters, and you need to enter your username and password when accessing a cluster through various clients or APIs. However, you don't need to do so if you select the Open Source Edition or Basic Edition.

When accessing a cluster, pay attention to the X-Pack edition selected. For more information, see Accessing a Cluster from a Client, Accessing a Cluster from CVM, and Accessing a Cluster from Kibana.

Special note on network selection:

  • For security reasons, Tencent Cloud ES clusters are built in a VPC, and the cluster data must be accessed within the same VPC.
  • When you purchase a cluster, the region and the availability zone you select must be configured with a VPC and a subnet.
  • Generally, a CVM in the same VPC should be used as the client to access ES clusters, and initiate requests for data storage and query.
  • If you are an existing user of Tencent Cloud and want to build an ES cluster based on existing data and services, you need to select the same VPC as that of your existing services when doing so.