OpenSearch Cluster Access Methods

There are many ways to connect to an OpenSearch cluster. Select the most appropriate access method based on the programming language you prefer. The various access methods support different types of network configurations. The cluster access addresses vary depending on the network configuration you choose. Select an appropriate network configuration method based on your network environment.

Access Methods

**Table 1** Cluster access methods
Access Method	Scenario	Details
OpenSearch Dashboards (recommended)	A graphical user interface Instance monitoring Data management These methods are language-irrelevant.	Logging In to an OpenSearch Cluster Through OpenSearch Dashboards
Cerebro		Logging In to an OpenSearch Cluster Through Cerebro
Open-source OpenSearch API	Run Curl commands to access and manage OpenSearch clusters.	Accessing an OpenSearch Cluster Using cURL Commands
Java	Use Java to access and manage OpenSearch clusters. To avoid compatibility issues, use the Java client that matches the software version of your OpenSearch cluster.	Accessing an OpenSearch Cluster Using the High Level REST Client Accessing an OpenSearch Cluster Using the Low Level REST Client
Python	Use Python to access and manage OpenSearch clusters.	Accessing an OpenSearch Cluster with the Python Client
LDAP Authentication	Enable Lightweight Directory Access Protocol (LDAP) authentication for an OpenSearch cluster.	Accessing an OpenSearch Cluster Using LDAP

Network Configuration

Configure the network of the OpenSearch cluster, and ensure that you have a server that can connect to the cluster's network. Obtain the cluster access address based on the selected network. Use this address to access the cluster.

**Table 2** Network configuration for the cluster
Network Environment	Access Method	Scenario	Details
Private network	Private IP address	Obtain the private IP address of each node in the cluster and access the cluster by connecting to one of these IP addresses. How to obtain: Log in to the CSS management console. In the navigation pane on the left, choose Clusters > OpenSearch. In the cluster list, obtain the target cluster's private IP address from the Private IP Address column. Generally, the IP address format is <host>:<port> or <host>:<port>,<host>:<port>. If the cluster has only one node, the IP address and port number of this one node are displayed, for example, 10.62.179.32:9200. If the cluster has multiple nodes, the IP addresses and port numbers of all nodes are displayed, for example, 10.62.179.32:9200,10.62.179.33:9200.	This is the default method.
Private network	IP address or private domain name of the VPC endpoint	Configure a VPC endpoint for the cluster, enabling cross-VPC access over the internal network. The cluster can be accessed via the VPC endpoint IP address or a private domain name. How to obtain: Log in to the CSS management console. In the navigation pane on the left, choose Clusters > OpenSearch. In the cluster list, click the name of the target cluster. The cluster information page is displayed. Choose Cluster Access > VPC Endpoint. In the VPC endpoint list below, record Service Address or Private Domain Name of the target VPC endpoint.	Configuring VPC Endpoint Service for an OpenSearch Cluster
Private network	Private IP address of a dedicated load balancer	Associate a dedicated load balancer with the cluster to enable access through the private IP address of this dedicated load balancer. How to obtain: Log in to the CSS management console. In the navigation pane on the left, choose Clusters > OpenSearch. In the cluster list, click the name of the target cluster. The cluster information page is displayed. Choose Cluster Access > Load Balancing. On the OpenSearch tab, find and record the private or public IP address of the target load balancer.	Configuring a Dedicated Load Balancer for an OpenSearch Cluster
Public network	Public IP address	Enable public network access for a security-mode cluster that uses HTTPS, and configure a whitelist for access control. The cluster can be accessed from the public network via its public IP address. How to obtain: Log in to the CSS management console. In the navigation pane on the left, choose Clusters > OpenSearch. In the cluster list, click the name of the target cluster. The cluster information page is displayed. Click the Overview tab. In the Configuration area, find and record the IP address used for public network access.	Configuring Public Network Access for an OpenSearch Cluster
Public network	Public IP address of a dedicated load balancer	Associate with the cluster a dedicated load balancer configured with an EIP to enable access through the public IP address of this dedicated load balancer. How to obtain: Log in to the CSS management console. In the navigation pane on the left, choose Clusters > OpenSearch. In the cluster list, click the name of the target cluster. The cluster information page is displayed. Choose Cluster Access > Load Balancing. On the OpenSearch tab, find and record the private or public IP address of the target load balancer.	Configuring a Dedicated Load Balancer for an OpenSearch Cluster