Use a client to access an Alibaba Cloud Elasticsearch cluster

Preparations

Before you use a client to access an Alibaba Cloud Elasticsearch cluster, make sure that you have completed the following operations:

• Install a JDK. The JDK version must be 1.8 or later.

  For more information, see Install a JDK.

• Create an Alibaba Cloud Elasticsearch cluster.

  For more information, see Create an Alibaba Cloud Elasticsearch cluster.

• Enable the Auto Indexing feature for the cluster.

  For more information, see Configure the YML file.

• Configure a whitelist for the cluster to ensure normal communication among networks.
  • If the server that runs code is located in an Internet environment, you can access the cluster by using its public endpoint. Before you access the cluster, you must enable the Public Network Access feature for the cluster and add the public IP address of the server to the public IP address whitelist of the cluster. For more information, see Configure a public or private IP address whitelist for an Elasticsearch cluster.
    Notice

    • If you are using a public network, add the IP address of the jump server that controls outbound traffic of the public network to the whitelist.
    • You can also add 0.0.0.0/0 to the whitelist to allow requests from all IPv4 addresses. If you make this configuration, all public IP addresses can be used to access the cluster. This poses security risks. We recommend that you evaluate the risks before you make this configuration.
  • If the server that runs code is located in the same virtual private cloud (VPC) as the cluster, you can access the cluster by using its internal endpoint. Before you access the cluster, make sure that the private IP address of the server is added to the private IP address whitelist of the cluster. By default, 0.0.0.0/0 is added to the whitelist.

PHP client

<?php
require 'vendor/autoload.php';
use Elasticsearch\ClientBuilder;

$client = ClientBuilder::create()->setHosts([
  [
    'host'   => '<HOST>',
    'port'   => '9200',
    'scheme' => 'http',
    'user'   => '<USER NAME>',
    'pass'   => '<PASSWORD>'
  ]
])->setConnectionPool('\Elasticsearch\ConnectionPool\SimpleConnectionPool', [])
  ->setRetries(10)->build();

$indexParams = [
  'index'  => 'my_index',
  'type'   => 'my_type',
  'id'     => '1',
  'body'   => ['testField' => 'abc'],
  'client' => [
    'timeout'         => 10,
    'connect_timeout' => 10
  ]
];
$indexResponse = $client->index($indexParams);
print_r($indexResponse);

$searchParams = [
  'index'  => 'my_index',
  'type'   => 'my_type',
  'body'   => [
    'query' => [
      'match' => [
        'testField' => 'abc'
      ]
    ]
  ],
  'client' => [
    'timeout'         => 10,
    'connect_timeout' => 10
  ]
];
$searchResponse = $client->search($searchParams);
print_r($searchResponse);
?>

Python client

To test the connectivity to the Elasticsearch cluster, connect a Python client to the cluster over port 9200. For more information, see elasticsearch-py. Sample code:

from elasticsearch import Elasticsearch, RequestsHttpConnection
import certifi
es = Elasticsearch(
    ['<HOST>'],
    http_auth=('<USERNAME>', '<PASSWORD>'),
    port=9200,
    use_ssl=False
)
res = es.index(index="my_index", doc_type="my_type", id=1, body={"title": "One", "tags": ["ruby"]})
res = es.get(index="my_index", doc_type="my_type", id=1)
print(res['_source'])

Java client

Go client

To test the connectivity to the Elasticsearch cluster, connect a Go client to the cluster over port 9200.

Before you use a Go client to access an Elasticsearch cluster, you must install a compilation environment for Go. For more information, see open source Elasticsearch documentation. In the following sample code, Go 1.13.4 is used.

package main

import (
    "context"
    "gopkg.in/olivere/elastic.v5"
    "gopkg.in/olivere/elastic.v5/config"
    "log"
)

const (
    url      = "http://es-cn-xxxxxx.public.elasticsearch.aliyuncs.com:9200"     //<1>
    username = "elastic"        //<2>
    password = "password"       //<3>
)

func main() {
    var sniff = false    //<4>  
    cfg := &config.Config{
        URL:      url,
        Username: username,
        Password: password,
    }

    cfg.Sniff = &sniff          
    var client, err = elastic.NewClientFromConfig(cfg)
    if err != nil {
        log.Println(err)
        return
    }

    exists, err := client.IndexExists("index_test").Do(context.Background())   //<5>
    if err != nil {
        log.Println(err)
    }
    log.Println(exists)
}

If the client is connected to the cluster, the following result is returned:

2019/11/29 10:07:37 true

For more information about the clients in other languages, see HTTP/REST Clients and Security.