Files
doc-exports/docs/css/umn/css_01_0440.html
zhengxiu 2125539080 css umn 25.1.0 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-07-04 09:10:17 +00:00

125 lines
15 KiB
HTML

<a name="css_01_0440"></a><a name="css_01_0440"></a>
<h1 class="topictitle1">OpenSearch Cluster Access Methods</h1>
<div id="body0000001992165561"><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p5636738181213">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.</p>
<div class="section" id="css_01_0440__css_01_0381_section11796104123519"><h4 class="sectiontitle">Access Methods</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_table114913297713" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Cluster access methods</caption><thead align="left"><tr id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_row914911291275"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.4.1.1"><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p10149152919711">Access Method</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.2.2.2.4.1.2"><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p41497296713">Scenario</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.2.2.2.4.1.3"><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p181496292716">Details</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_row214982915714"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.4.1.1 "><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p10149329877">OpenSearch Dashboards (recommended)</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="45%" headers="mcps1.3.2.2.2.4.1.2 "><ul id="css_01_0440__css_01_0381_ul137611993411"><li id="css_01_0440__css_01_0381_li10768943419">A graphical user interface</li><li id="css_01_0440__css_01_0381_li1976109153411">Instance monitoring</li><li id="css_01_0440__css_01_0381_li3768923417">Data management</li></ul>
<p id="css_01_0440__css_01_0381_p816317353418">Language-irrelevant</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.2.2.4.1.3 "><p id="css_01_0440__css_01_0381_p55472300189"><a href="css_01_0441.html">Logging In to an OpenSearch Cluster Using OpenSearch Dashboards</a></p>
</td>
</tr>
<tr id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_row123514502113"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.4.1.1 "><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p1835135010115">Cerebro</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.4.1.2 "><p id="css_01_0440__css_01_0381_p638218320185"><a href="css_01_0442.html">Logging In to an OpenSearch Cluster Through Cerebro</a></p>
</td>
</tr>
<tr id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_row814919291979"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.4.1.1 "><p id="css_01_0440__css_01_0381_en-us_topic_0000001961259049_p1314918291713">Open-source OpenSearch API</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.2.2.4.1.2 "><p id="css_01_0440__css_01_0381_p6586103219425">Run Curl commands to access and manage OpenSearch clusters.</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.2.2.4.1.3 "><p id="css_01_0440__css_01_0381_p1211319351183"><a href="css_01_0443.html">Accessing an OpenSearch Cluster Using cURL Commands</a></p>
</td>
</tr>
<tr id="css_01_0440__row61193199190"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.4.1.1 "><p id="css_01_0440__p1035012257149">LDAP Authentication</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.2.2.4.1.2 "><p id="css_01_0440__p8350162531410">Enable Lightweight Directory Access Protocol (LDAP) authentication for an OpenSearch cluster.</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.2.2.4.1.3 "><p id="css_01_0440__p631351202110"><a href="css_01_0452.html">Accessing an OpenSearch Cluster Using LDAP</a></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_01_0440__css_01_0381_section855085010198"><a name="css_01_0440__css_01_0381_section855085010198"></a><a name="css_01_0381_section855085010198"></a><h4 class="sectiontitle">Network Configuration</h4><p id="css_01_0440__css_01_0381_p1217520132115">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. With the exception of OpenSearch Dashboards and Cerebro, which support one-click cluster access so there is no need to provide the cluster address, the cluster address needs to be provided for all other access methods.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0440__css_01_0381_table1347204518562" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Network configuration for the cluster</caption><thead align="left"><tr id="css_01_0440__css_01_0381_row647745155612"><th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.1"><p id="css_01_0440__css_01_0381_p1447194595616">Network Environment</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="css_01_0440__css_01_0381_p04744535611">Access Method</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.3"><p id="css_01_0440__css_01_0381_p947154512569">Scenario</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.4"><p id="css_01_0440__css_01_0381_p18605558125611">Details</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0440__css_01_0381_row10471545175611"><td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_01_0440__css_01_0381_p1868247961">Private network</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_01_0440__css_01_0381_p547174525617">Private IP address</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_01_0440__css_01_0381_p65041751486">Obtain the IP address of each node from the cluster information page, and access the cluster by connecting to one of these IP addresses directly.</p>
<p id="css_01_0440__css_01_0381_p2704840164314">How to obtain:</p>
<ol id="css_01_0440__css_01_0381_ol15355114704317"><li id="css_01_0440__css_01_0384_en-us_topic_0000001961178833_li07251912434">In the navigation pane on the left, choose <span class="wintitle" id="css_01_0440__css_01_0384_wintitle8395155017380"><b>Clusters</b></span>.</li><li id="css_01_0440__css_01_0384_en-us_topic_0000001961178833_li392216231538">In the cluster list, obtain the IP address of the cluster you want to access from the <strong id="css_01_0440__css_01_0384_b1213816218488">Private Network Address</strong> column. Generally, the IP address format is <em id="css_01_0440__css_01_0384_i913822112488">&lt;host&gt;</em><strong id="css_01_0440__css_01_0384_b11381215483">:</strong><em id="css_01_0440__css_01_0384_i131381621114811">&lt;port&gt;</em> or <em id="css_01_0440__css_01_0384_i9139122154816">&lt;host&gt;</em><strong id="css_01_0440__css_01_0384_b3139821144816">:</strong><em id="css_01_0440__css_01_0384_i71391521194817">&lt;port&gt;</em><strong id="css_01_0440__css_01_0384_b1813942115484">,</strong><em id="css_01_0440__css_01_0384_i1713918215481">&lt;host&gt;</em><strong id="css_01_0440__css_01_0384_b101391921114810">:</strong><em id="css_01_0440__css_01_0384_i111392216488">&lt;port&gt;</em>.<p id="css_01_0440__css_01_0384_en-us_topic_0000001961178833_p18422185125018">If the cluster has only one node, the IP address and port number of this one node are displayed, for example, <strong id="css_01_0440__css_01_0384_b310751519481">10.62.179.32:9200</strong>. If the cluster has multiple nodes, the IP addresses and port numbers of all nodes are displayed, for example, <strong id="css_01_0440__css_01_0384_b1610791594811">10.62.179.32:9200,10.62.179.33:9200</strong>.</p>
</li></ol>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_01_0440__css_01_0381_p8605658155615">This is the default method.</p>
</td>
</tr>
<tr id="css_01_0440__css_01_0381_row19471745185619"><td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_01_0440__css_01_0381_p2120153044718">Private network</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_01_0440__css_01_0381_p18471245125619">IP address or private domain name of the VPC endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_01_0440__css_01_0381_p1137982710178">Configure a VPC endpoint to access the cluster from a different VPC over an internal network. Do not use this method if high performance standards are used.</p>
<p id="css_01_0440__css_01_0381_p195147543433">How to obtain:</p>
<ol id="css_01_0440__css_01_0381_ol89568434411"><li id="css_01_0440__css_01_0381_li1895615416443">In the navigation pane on the left, choose <span class="wintitle" id="css_01_0440__css_01_0381_wintitle149572434418"><b>Clusters</b></span>.</li><li id="css_01_0440__css_01_0381_li99579404419">On the <span class="wintitle" id="css_01_0440__css_01_0381_wintitle1926014597469"><b>Clusters</b></span> page, click the name of the cluster you want to access. The <strong id="css_01_0440__css_01_0381_b92601859184617">Cluster Information</strong> page is displayed.</li><li id="css_01_0440__css_01_0381_li1495718434414">In the navigation pane, choose VPC Endpoint Service. Record the service address or private domain name of the VPC endpoint.</li></ol>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_01_0440__css_01_0381_p7605115812562"><a href="css_01_0477.html">Configuring VPC Endpoint Service for an OpenSearch Cluster</a></p>
</td>
</tr>
<tr id="css_01_0440__css_01_0381_row5471345195614"><td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_01_0440__css_01_0381_p2012073014715">Private network</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_01_0440__css_01_0381_p1147104514565">Private IP address of a dedicated load balancer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_01_0440__css_01_0381_p747134565619">Access the cluster through a dedicated load balancer. Use this method if high performance standards are used.</p>
<p id="css_01_0440__css_01_0381_p534217917444">How to obtain:</p>
<ol id="css_01_0440__css_01_0381_ol10184921174419"><li id="css_01_0440__css_01_0381_li131841021174410">In the navigation pane on the left, choose <span class="wintitle" id="css_01_0440__css_01_0381_wintitle121841621164416"><b>Clusters</b></span>.</li><li id="css_01_0440__css_01_0381_li3184142119448">On the <span class="wintitle" id="css_01_0440__wintitle117755043825637"><b>Clusters</b></span> page, click the name of the cluster you want to access. The <strong id="css_01_0440__b149648060425637">Cluster Information</strong> page is displayed.</li><li id="css_01_0440__css_01_0381_li518410215446">In the navigation pane, choose <strong id="css_01_0440__b67689785325637">Load Balancing</strong>. Record the private IP address of the load balancer.</li></ol>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_01_0440__css_01_0381_p126051358135617"><a href="css_01_0478.html">Configuring a Dedicated Load Balancer for an OpenSearch Cluster</a></p>
</td>
</tr>
<tr id="css_01_0440__css_01_0381_row24711456565"><td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_01_0440__css_01_0381_p182194919615">Public network</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_01_0440__css_01_0381_p16473456560">Public IP address</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_01_0440__css_01_0381_p146711816142219">Configure a whitelist to control public network access to the cluster. Use this method only for security-mode clusters that use HTTPS.</p>
<p id="css_01_0440__css_01_0381_p6592202544416">How to obtain:</p>
<ol id="css_01_0440__css_01_0381_ol1772853410441"><li id="css_01_0440__css_01_0381_li17291534194416">In the navigation pane on the left, choose <span class="wintitle" id="css_01_0440__css_01_0381_wintitle9729143454416"><b>Clusters</b></span>.</li><li id="css_01_0440__css_01_0381_li19729163494417">On the <span class="wintitle" id="css_01_0440__wintitle47577787425637"><b>Clusters</b></span> page, click the name of the cluster you want to access. The <strong id="css_01_0440__b207643564025637">Cluster Information</strong> page is displayed. Record the cluster's public network address.</li></ol>
<div class="note" id="css_01_0440__css_01_0381_note10248468294"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0440__css_01_0381_p22483682916">Use this method only for security-mode clusters that use HTTPS.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_01_0440__css_01_0381_p46051058145613"><a href="css_01_0476.html">Configuring Public Network Access for an OpenSearch Cluster</a></p>
</td>
</tr>
<tr id="css_01_0440__css_01_0381_row1247184520564"><td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_01_0440__css_01_0381_p1199104010475">Public network</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_01_0440__css_01_0381_p2528814359">Public IP address of a dedicated load balancer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_01_0440__css_01_0381_p351519142246">Access the cluster through a dedicated load balancer. Use this method if high performance standards are used.</p>
<ol id="css_01_0440__css_01_0381_ol164661948114413"><li id="css_01_0440__css_01_0381_li104672485446">In the navigation pane on the left, choose <span class="wintitle" id="css_01_0440__css_01_0381_wintitle114671248174416"><b>Clusters</b></span>.</li><li id="css_01_0440__css_01_0381_li114674489444">On the <span class="wintitle" id="css_01_0440__wintitle164368067625637"><b>Clusters</b></span> page, click the name of the cluster you want to access. The <strong id="css_01_0440__b74547898325637">Cluster Information</strong> page is displayed.</li><li id="css_01_0440__css_01_0381_li184675485440">In the navigation pane, choose <strong id="css_01_0440__b85440484125637">Load Balancing</strong>. Record the public IP address of the load balancer.</li></ol>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_01_0440__css_01_0381_p19605155835614"><a href="css_01_0478.html">Configuring a Dedicated Load Balancer for an OpenSearch Cluster</a></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0288.html">Accessing an OpenSearch Cluster</a></div>
</div>
</div>