This topic describes the basics of using the ApsaraDB for HBase OpenAPI.
OpenAPI overview
Alibaba Cloud offers the OpenAPI portal to help you use OpenAPI efficiently. The portal is a comprehensive product that integrates features such as intelligent API search, documentation, online debugging, SDK acquisition, code samples, call error diagnosis, and call statistics. In the OpenAPI portal, you can call the OpenAPI operations of various Alibaba Cloud products and view the requests and responses. The OpenAPI portal also automatically generates SDK code samples to help you get started quickly. For more information, see What is OpenAPI.
Versions
Alibaba Cloud OpenAPI uses version numbers to manage APIs for ApsaraDB for Hbase clusters with different architectures. The following are the API versions that ApsaraDB for HBase supports.
|
Version |
Description |
|
2019-01-01 |
Use this version to call API operations for all ApsaraDB for Hbase clusters. |
Online debugging
ApsaraDB for Hbase provides features such as API debugging in the OpenAPI Portal. Before you make a call, you need to understand information such as the versions, endpoint descriptions, and integration methods provided by ApsaraDB for Hbase.
On the OpenAPI portal page, the left pane contains the API navigation tree with categories such as service regions, clusters, instances, security, and backups. The debugging panel is in the middle, where you can select a service address, configure request parameters such as AcceptLanguage and Engine, and then click Initiate Call. The right pane displays documentation, including descriptions of request and response parameters, as well as SDK and CLI examples.
Debugging portal
For the API debugging portal of ApsaraDB for Hbase, see API Debugging Portal.
Endpoints
To minimize latency, select an endpoint in the same region as your resources. For example, the VPC endpoint in the China (Qingdao) region is hbase.aliyuncs.com.
-
Public endpoints are globally accessible.
-
A Virtual Private Cloud (VPC) is an isolated virtual network. The advantages of using a VPC endpoint are:
-
Higher security: VPC endpoints are accessible only within a VPC, providing enhanced security.
-
Faster response times: VPC endpoints operate within a VPC internal network, which typically results in faster responses and avoids public network latency.
-
Lower costs: VPC endpoints use internal network communication.
-
For more information, see request structure.
User identities
When you log on to the OpenAPI portal, the portal uses your current account for online debugging by default. Because an Alibaba Cloud account has permissions to access all APIs, using it for debugging poses a high security risk. We recommend that you do not use your Alibaba Cloud account for online debugging. We recommend that you create and use a RAM user for API access and daily O&M. Before you call API operations, grant the RAM user only the required permissions. The RAM user must have permission to manage ApsaraDB for Hbase. For more information, see Create custom RAM authorization policies.
|
User identity |
Supported |
|
Supported |
|
|
RAM user (Recommended) |
Supported |
|
RAM role (Recommended) |
Supported |
Integration methods
ApsaraDB for Hbase provides multiple integration methods, including Alibaba Cloud SDKs and custom encapsulation. You can choose the method that best suits your business needs.
SDKs are easy to integrate and are the recommended way to call OpenAPI operations.
|
Integration method |
Supported |
|
Alibaba Cloud SDK |
Supported |
|
Alibaba Cloud CLI |
Supported |
|
Terraform |
Supported |
|
Resource Orchestration Service (ROS) |
Supported |
|
Custom encapsulation |
Supported |
Alibaba Cloud SDK
-
Alibaba Cloud provides SDKs in various programming languages, such as Java, C#, Go, Python, PHP, and C++. The SDKs handle the underlying details of API calls, such as identity, authentication, and signature rules. You only need to integrate an SDK to call OpenAPI operations directly. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.
-
You can use Alibaba Cloud SDKs to call the OpenAPI operations of ApsaraDB for Hbase. For supported languages and installation instructions, see Install SDKs.
Alibaba Cloud CLI
-
Alibaba Cloud CLI is a command-line tool that lets you manage your Alibaba Cloud services and resources with the
aliyuncommand. For more information, see What is Alibaba Cloud CLI. -
You can use Alibaba Cloud CLI to call the OpenAPI operations of ApsaraDB for Hbase. For more information, see Call an RPC API.
Resource Orchestration Service (ROS)
-
Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies the management of cloud resources. You can write templates to define your required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS engine then automatically creates and configures all resources based on the template, which enables automated deployment and O&M. For more information, see What is Resource Orchestration Service.
-
You can use ROS to orchestrate and call ApsaraDB for Hbase resources. For a list of supported resources and data sources, see Resources supported by ROS.
Custom encapsulation
You can create custom encapsulated requests to access Alibaba Cloud OpenAPI by following the V3 signature documentation for SDKs. For native HTTP calls, you must implement the signing algorithm, construct the requests, and then send them. For more details on the signature mechanism, see V3 request body and signature mechanism.
Notes
If an API call returns an error, refer to the returned error code to check your request parameters and values. For more information, see Error Code Center.
You can also record the RequestID or SDK error message from the response and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service diagnostics.