ApsaraDB for HBase:Multi-language API access

Prerequisites

Before you begin, ensure that you have:

• The endpoint of your cluster. To get the endpoint, see Apply for a public endpoint

How it works

ApsaraDB for HBase Performance-enhanced Edition uses HTTP at the Thrift transport layer. All clients must use THttpClient — not the standard socket transport — to connect. For Thrift 2, you must specify the username and the password as custom HTTP headers in the THttpClient instance.

Thrift 1 vs. Thrift 2

Use Thrift 2 for new integrations. Thrift 1 lacks authentication support and is unsuitable for clusters with ACL enabled.

Set up Thrift

Initialize a client

The following example uses Python. Apply the same pattern to other languages: create a THttpClient, add the authentication headers, wrap it in TBinaryProtocol, and pass the protocol to the THBaseService.Client.

# -*- coding: utf-8 -*-
# Install the Thrift library: pip install thrift
from thrift.protocol import TBinaryProtocol
from thrift.transport import THttpClient

# Generated by: thrift --gen py Hbase.thrift
from hbase import THBaseService
from hbase.ttypes import (
    TColumnValue, TColumn, TTableName, TTableDescriptor,
    TColumnFamilyDescriptor, TNamespaceDescriptor,
    TGet, TPut, TScan
)

# Replace <host> with your cluster endpoint.
url = "http://<host>:9190"

# THttpClient is required — the HBase Thrift server uses HTTP transport,
# not the standard socket transport.
transport = THttpClient.THttpClient(url)

# Pass credentials as custom HTTP headers. Thrift 2 requires the username and password.
headers = {
    "ACCESSKEYID": "<your-username>",       # Cluster username
    "ACCESSSIGNATURE": "<your-password>",   # Cluster password
}
transport.setCustomHeaders(headers)

# TBinaryProtocolAccelerated uses a C extension for faster serialization
# when available, and falls back to the pure-Python implementation.
protocol = TBinaryProtocol.TBinaryProtocolAccelerated(transport)

# Create the HBase client using the configured protocol.
client = THBaseService.Client(protocol)

# Open the connection before making any calls.
transport.open()

# Your HBase operations go here.

# Close the transport when done to release the connection.
transport.close()

Placeholders:

Sample code

Complete, runnable client examples for each language are available on GitHub. Each repository includes the Thrift definition files and any language-specific dependencies.

What's next

• Apache Thrift tutorial — learn more about Thrift operations across all supported languages