Open-source Elasticsearch provides a series of RESTful APIs. You can run cURL commands to access these APIs using tools such as Kibana and Postman. This topic describes how to use cURL commands to access an Elasticsearch cluster.
This topic uses a private IP address as an example to describe how to access a cluster. The cluster access address varies with the network configurations used. For details, see Network Configuration.
If the cluster has only one node, the IP address and port number of this single node are displayed, for example, 10.62.179.32:9200. If the cluster has multiple nodes and all of them are data nodes, the IP addresses and port numbers of all these nodes are displayed; if some of them are client nodes, only the IP addresses and port numbers of these client nodes are displayed; for example, 10.62.179.32:9200,10.62.179.33:9200.
curl "http://<host>:<port>"
curl -u <user>:<password> "http://<host>:<port>"
curl -u <user>:<password> -k "https://<host>:<port>"
Variable | Description |
|---|---|
<host> | IP address of each node in the cluster. If the cluster contains multiple nodes, there will be multiple IP addresses. You can use any of them. |
<port> | Port number for accessing a cluster node. Generally, the port number is 9200. |
<user> | Username for accessing the cluster. |
<password> | Password of the user. If the password contains special characters, enclose the username and password in single quotation marks, for example, curl -u "user:password!" "http://<host>:<port>". |
An access example is as follows:
curl "http://10.62.176.32:9200"
Information similar to the following is displayed:
HTTP/1.1 200 OKcontent-type: application/json; charset=UTF-8content-length: 513{"name" : "xxx-1","cluster_name" : "xxx","cluster_uuid" : "xxx_uuid","version" : {"number" : "7.10.2","build_flavor" : "oss","build_type" : "tar","build_hash" : "unknown","build_date" : "unknown","build_snapshot" : true,"lucene_version" : "8.7.0","minimum_wire_compatibility_version" : "6.7.0","minimum_index_compatibility_version" : "6.0.0-beta1"},"tagline" : "You Know, for Search"}
For more commands, see the Elasticsearch documentation.