このトピックでは、ApsaraDB for Hbase の OpenAPI を使用するための基本事項について説明します。
OpenAPI の概要
Alibaba Cloud は、OpenAPI を効率的に使用できるように OpenAPI ポータルを提供しています。このポータルは、インテリジェント API 検索、ドキュメント、オンラインデバッグ、SDK 取得、コードサンプル、呼び出しエラー診断、呼び出し統計などの機能を統合した包括的な製品です。OpenAPI ポータルでは、さまざまな Alibaba Cloud 製品の OpenAPI 操作を呼び出し、リクエストとレスポンスを確認できます。また、OpenAPI ポータルは SDK コードサンプルを自動的に生成するため、すぐに開始できます。詳細については、「OpenAPI とは」をご参照ください。
バージョン
Alibaba Cloud OpenAPI では、バージョン番号を使用して、アーキテクチャが異なるApsaraDB for Hbase クラスターの API を管理します。以下は、ApsaraDB for HBase がサポートする API バージョンです。
|
バージョン |
説明 |
|
2019-01-01 |
すべての ApsaraDB for Hbase クラスターの API 操作を呼び出すには、このバージョンを使用します。 |
オンラインデバッグ
ApsaraDB for Hbase は、OpenAPI Portal での API デバッグなどの機能を提供しています。呼び出しを行う前に、ApsaraDB for Hbase が提供するバージョン、エンドポイントの説明、および統合方法などの情報を理解する必要があります。
OpenAPI ポータルページでは、左側のペインにサービスリージョン、クラスター、インスタンス、セキュリティ、バックアップなどのカテゴリを含む API ナビゲーションツリーが表示されます。中央にはデバッグパネルがあり、サービスアドレスを選択し、AcceptLanguage や Engine などのリクエストパラメータを設定してから、[Initiate Call] をクリックできます。右側のペインには、リクエストパラメータとレスポンスパラメータの説明、SDK と CLI の例を含むドキュメントが表示されます。
デバッグポータル
ApsaraDB for Hbase の API デバッグポータルについては、「API デバッグポータル」をご参照ください。
エンドポイント
レイテンシーを最小限に抑えるには、リソースと同じリージョンのエンドポイントを選択してください。たとえば、中国 (青島) リージョンの VPC エンドポイントは hbase.aliyuncs.com です。
-
パブリックエンドポイントはグローバルにアクセス可能です。
-
仮想プライベートクラウド (VPC) は、分離された仮想ネットワークです。VPC エンドポイントを使用する利点は次のとおりです。
-
セキュリティの向上:VPC エンドポイントは VPC 内でのみアクセス可能であり、セキュリティが強化されます。
-
レスポンス時間の短縮:VPC エンドポイントは VPC 内部ネットワーク内で動作するため、通常はレスポンスが高速化され、パブリックネットワークの遅延を回避できます。
-
コストの削減:VPC エンドポイントは内部ネットワーク通信を使用します。
-
詳細については、「リクエスト構造」をご参照ください。
ユーザーアイデンティティ
OpenAPI ポータルにログインすると、ポータルはデフォルトで現在のアカウントをオンラインデバッグに使用します。 Alibaba Cloud アカウントはすべての API にアクセスする権限を持っているため、デバッグに使用すると高いセキュリティリスクが生じます。 オンラインデバッグに Alibaba Cloud アカウントを使用しないことを推奨します。 API アクセスおよび日常の O&M には、RAM ユーザーを作成して使用することを推奨します。 API 操作を呼び出す前に、RAM ユーザーに必要な権限のみを付与してください。 RAM ユーザーは ApsaraDB for Hbase を管理する権限を持っている必要があります。 詳細については、「カスタム RAM 承認ポリシーの作成」をご参照ください。
|
ユーザーアイデンティティ |
サポート状況 |
|
サポートされています |
|
|
RAM ユーザー (推奨) |
サポートされています |
|
RAM ロール (推奨) |
サポートされています |
統合方法
ApsaraDB for Hbase は、Alibaba Cloud SDK やカスタムカプセル化など、複数の統合方法を提供しています。お客様のビジネスニーズに最も適した方法を選択できます。
SDK は統合が容易であり、OpenAPI 操作を呼び出す方法として推奨します。
|
統合方法 |
サポート状況 |
|
Alibaba Cloud SDK |
サポートされています |
|
Alibaba Cloud CLI |
サポートされています |
|
Terraform |
サポートされています |
|
Resource Orchestration Service (ROS) |
サポートされています |
|
独自のカプセル化 |
サポートされています |
Alibaba Cloud SDK
-
Alibaba Cloud は、Java、C#、Go、Python、PHP、C++ など、さまざまなプログラミング言語の SDK を提供しています。SDK は、アイデンティティ、認証、署名ルールなど、API 呼び出しの基盤となる詳細を処理します。SDK を統合するだけで、OpenAPI 操作を直接呼び出すことができます。Alibaba Cloud SDK の詳細については、「Alibaba Cloud SDK」をご参照ください。
-
Alibaba Cloud SDK を使用して、ApsaraDB for Hbase の OpenAPI 操作を呼び出すことができます。 サポートされている言語とインストール手順については、SDK のインストールをご参照ください。
Alibaba Cloud CLI
-
Alibaba Cloud CLI は、
aliyunコマンドを使用して Alibaba Cloud サービスとリソースを管理できるコマンドラインツールです。詳細については、「Alibaba Cloud CLI とは」をご参照ください。 -
Alibaba Cloud CLI を使用して、ApsaraDB for Hbase の OpenAPI オペレーションを呼び出すことができます。詳細については、「RPC API を呼び出す」をご参照ください。
Resource Orchestration Service (ROS)
-
Resource Orchestration Service (ROS) は、クラウドリソースの管理を簡素化する Alibaba Cloud サービスです。テンプレートを作成して、ECS インスタンスや RDS データベースインスタンスなどの必要な Alibaba Cloud リソースとその依存関係を定義できます。その後、ROS エンジンがテンプレートに基づいてすべてのリソースを自動的に作成および設定し、自動化されたデプロイと運用・保守を実現します。詳細については、「Resource Orchestration Service とは」をご参照ください。
-
ROS を使用して ApsaraDB for Hbase のリソースをオーケストレーションし、呼び出すことができます。サポートされているリソースとデータソースのリストについては、「ROS でサポートされているリソース」をご参照ください。
独自のカプセル化
V3 署名ドキュメントに従って、独自のカプセル化されたリクエストを作成し、Alibaba Cloud OpenAPI にアクセスできます。ネイティブ HTTP 呼び出しの場合、署名アルゴリズムを実装し、リクエストを構築してから送信する必要があります。署名メカニズムの詳細については、「V3 リクエストボディと署名メカニズム」をご参照ください。
注意事項
API 呼び出しがエラーを返した場合は、返されたエラーコードを参照して、リクエストパラメータと値を確認してください。詳細については、「エラーコードセンター」をご参照ください。
また、レスポンスからリクエスト ID または SDK エラーメッセージを記録し、Alibaba Cloud OpenAPI Diagnostic Platform を使用してセルフサービス診断を行うこともできます。