All Products
Search
Document Center

ApsaraDB for HBase:Connect to a performance-enhanced cluster with HBase Shell

Last Updated:Apr 13, 2026

This topic explains how to use HBase Shell to connect to an ApsaraDB for HBase Performance-enhanced Edition instance.

Prerequisites

  • If connecting from a private network, ensure your ECS instance is in the same VPC as the ApsaraDB for HBase Performance-enhanced Edition instance. You must also add the IP address of the ECS instance to the whitelist of the ApsaraDB for HBase instance.

  • If you connect from the internet, you must configure a whitelist. For more information, see Configure a whitelist.

Usage

To connect to the wide-column engine with HBase Shell, a Linux or macOS environment is strongly recommended. If you use a Windows environment, you may encounter errors or issues with missing libraries. You must add the required libraries to your system based on the error messages.

Procedure

  1. Download the HBase Shell package.

    1. Log on to the ApsaraDB for HBase console.

    2. On the Clusters page, click the target instance ID to open the instance details page.

    3. In the left-side navigation pane, click Database Connection.

    4. In the Connection Information section, click HBase Shell download to download the package.

  2. Decompress the downloaded HBase Shell package, and then modify the hbase-site.xml file to add the following configuration.

    <configuration>        
       <!-- The endpoint of the instance. You can obtain the endpoint on the Database Connection page of the console. Note the difference between a public endpoint and a private endpoint. -->        
    <property>       
         <name>hbase.zookeeper.quorum</name>        
         <value>ld-bp1utwvg3zfou****-proxy-hbase.hbase.xxx.rds.aliyuncs.com:30020</value>    
    </property>    
    <!-- Set the username and password. The default value for both is root. Modify them based on your business requirements. -->        
    <property>        
         <name>hbase.client.username</name>        
         <value>testuser</value>   
    </property>    
    <property>        
         <name>hbase.client.password</name>        
         <value>password</value>   
    </property>
    </configuration>  
  3. Run the bin/hbase shell command to connect to your ApsaraDB for HBase Performance-enhanced Edition instance.

    Note

    When using HBase Shell to connect to an ApsaraDB for HBase Performance-enhanced Edition (Lindorm) instance, you can perform only simple DDL and data read/write operations. Management commands, such as balance and move, are disabled. For more information, see Limitations.