Help Center/ GeminiDB/ GeminiDB HBase API/ Working with GeminiDB HBase API/ Instance Connection and Management/ Connecting to a GeminiDB HBase Instance over a Private Network
Updated on 2025-08-05 GMT+08:00

Connecting to a GeminiDB HBase Instance over a Private Network

You can install the HBase client on an ECS and access a GeminiDB HBase instance using a private IP address.

Prerequisites

  • For details about how to create an ECS, see Purchasing an ECS in Getting Started with Elastic Cloud Server.
  • JDK has been installed on the ECS.
  • Download the HBase client. Click a directory of the latest version 2.6.X and download hbase-2.6.X-client-bin.tar.gz. For example, if the latest version is 2.6.1, click that directory and download hbase-2.6.1-client-bin.tar.gz. HBase 1.X is not recommended due to compatibility issues.
  1. Log in to the ECS.

    For details, see Logging In to an ECS in Getting Started with Elastic Cloud Server.

  2. Upload the HBase client installation package to the ECS.
  3. Run the following command to decompress the client package. Replace the package name with the actual one.

    tar -xvf hbase-2.6.1-client-bin.tar.gz

  4. Add the following configurations to conf/hbase-site.xml in the client directory and set value to the IP address of your instance. Use commas (,) to separate multiple IP addresses. By default, you do not need to set the port. You can obtain the private IP address by following Viewing the Instance IP Address.

    <configuration> 
      <property>
        <name>hbase.zookeeper.quorum</name>
        <value>127.0.0.1,127.0.0.2,127.0.0.3</value>
      </property>
    </configuration>

  5. Go to the bin directory of the decompressed client and run the following command to connect to the instance: Replace YOUR_USERNAME and YOUR_PASSWORD with the user password set during instance creation. The username is fixed to rwuser. If you use a stress test tool to connect to the instance, you also need to set the username and password.

    export HADOOP_PROXY_USER="YOUR_USERNAME"
    export HADOOP_USER_NAME="YOUR_PASSWORD"
    ./hbase shell

  6. Check the results. If the following is displayed, the connection is successful.

    hbase:001:0>