Облачная платформаAdvanced

Connecting to a Cluster Using cURL Commands

Эта статья полезна?

Язык статьи: Английский

To query or analyze data in OpenSearch, you often need to connect to your cluster from an external client (such as an ECS). This topic describes how to use cURL commands to access an OpenSearch cluster.

Prerequisites

The target CSS OpenSearch cluster is available.

An ECS has been created, and it is in the same VPC and security group as the CSS cluster.

If they are not in the same security group, modify the ECS security group, or configure its inbound and outbound rules to allow all access from the cluster. For details, see the Virtual Private Cloud User Guide.

For details about how to use an ECS, see Elastic Cloud Server User Guide.

Accessing a Cluster

Obtain the private network address of the cluster. It is used to access the cluster.

This topic uses a private IP address as an example to describe how to access a cluster. The cluster access address varies depending on the network configurations used. For details, see Obtaining the Cluster Access Address.

In the navigation pane on the left, choose Clusters > OpenSearch.

In the cluster list, obtain the target cluster's internal network address from the Internal Network Address column. Typical address format: <host>:<port> or <host>:<port>,<host>:<port>. Example: 10.62.179.32:9200,10.62.179.33:9200.

If the cluster has client nodes, only the IP addresses and ports of all the client nodes are displayed. Otherwise, the IP addresses and ports of all data nodes and cold data nodes are displayed.

Run one of the following commands on the ECS to access the cluster. The access command varies depending on the security mode of the cluster.

For a cluster with the security mode disabled:

curl "http://<host>:<port>"

For a security-mode cluster that uses HTTP:

curl -u <user>:<password> "http://<host>:<port>"

For a security-mode cluster that uses HTTPS:

curl -u <user>:<password> -k "https://<host>:<port>"

Table 1 Variables
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>".

Example command:

curl "http://10.62.176.32:9200"

Example response:

HTTP/1.1 200 OK
content-type: application/json; charset=UTF-8
content-length: 513

{
  "name" : "css-xxx-ess-esn-3-1",
  "cluster_name" : "css-xxx",
  "cluster_uuid" : "xxx_uuid",
  "version" : {
    "number" : "7.10.2",
    "build_type" : "tar",
    "build_hash" : "unknown",
    "build_date" : "unknown",
    "build_snapshot" : true,
    "lucene_version" : "9.12.1",
    "minimum_wire_compatibility_version" : "7.10.0",
    "minimum_index_compatibility_version" : "7.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}

For more commands, see the OpenSearch documentation.

Parent topic: Connecting to Clusters

Предыдущая статья

Connecting to a Cluster Using Python

Следующая статья

Ingesting Data

Эта статья полезна?

Поддержка Юридические документы Политика конфиденциальности