このトピックでは、Lindorm の OpenAPI を使用するための基本情報と注意事項について説明します。
OpenAPI
Alibaba Cloud は、クラウド製品 API を迅速に学習および使用できるよう、OpenAPI ポータルを提供します。このポータルは、インテリジェント API 検索、ドキュメント、オンラインデバッグ、SDK アクセス、コードサンプル、エラー診断、呼び出し統計などの機能を備えたワンストップソリューションです。このポータルを使用して、さまざまな Alibaba Cloud 製品の API を呼び出し、リクエストとレスポンスを確認し、SDK サンプルコードを自動生成して、迅速に利用を開始できます。詳細については、「OpenAPI とは」をご参照ください。
バージョン
Alibaba Cloud OpenAPI は、バージョン番号を使用して、異なるアーキテクチャの Lindorm クラスターの API を管理します。以下は、Lindorm がサポートする API バージョンとその説明です。
バージョン | 説明 |
2020-06-15 | すべての Lindorm インスタンスは、このバージョン番号を使用して API を呼び出します。 |
オンラインデバッグ
Lindorm は、OpenAPI ポータルで API デバッグなどの機能を提供します。API を呼び出す前に、Lindorm のバージョン、エンドポイントの説明、および統合方法を理解する必要があります。OpenAPI ポータルにログインします。左側メニューで、API バージョン 2020-06-15 を選択します。リージョンカテゴリで、DescribeRegions API を選択すると、Lindorm がサポートするすべてのリージョンを取得できます。[サービスアドレス] ドロップダウンリストから、中国 (杭州) などのターゲットリージョンを選択します。パラメータ設定セクションで、AcceptLanguage パラメータ (文字列、例の値:zh-CN) を設定できます。レスポンスパラメータには、RequestId (文字列) と Regions (リージョンのリスト) が含まれます。設定が完了したら、[呼び出しの開始] をクリックします。
デバッグポータル
Lindorm の API Explorer は、API Explorer で利用できます。
エンドポイント
レイテンシーを低減するために、リソースが配置されているリージョンのエンドポイントを選択してください。たとえば、中国 (青島) リージョンの VPC エンドポイントは hitsdb-vpc.cn-qingdao.aliyuncs.com です。
-
パブリックエンドポイントは、グローバルにアクセス可能です。
-
Virtual Private Cloud (VPC) は、分離された仮想ネットワークです。VPC エンドポイントには、次の利点があります。
-
高いセキュリティ:VPC エンドポイントは VPC 内からのみアクセス可能なため、セキュリティとプライバシーが向上します。
-
高速なレスポンス:内部ネットワークを使用することで、VPC エンドポイントはパブリックエンドポイントよりも高速なレスポンスを実現し、パブリックネットワークのレイテンシーや帯域幅制限の影響を受けません。
-
低コスト:VPC エンドポイントを使用すると、内部ネットワークを介した通信が行われるため、データ転送コストを削減できます。
-
応答の高速化: 内部ネットワークを使用することで、VPC エンドポイントはパブリックエンドポイントよりも高速な応答時間を実現し、パブリックネットワークのレイテンシーや帯域幅の制限を受けません。
コストの削減: VPC エンドポイントを使用すると、通信が内部ネットワーク経由で行われるため、データ転送コストを削減できます。
詳細については、「エンドポイント」をご参照ください。
ユーザーアイデンティティ
OpenAPI Web サイトにログインすると、OpenAPI はデフォルトでログインしたアカウントをオンライン API デバッグに使用します。Alibaba Cloud アカウントには、すべての API にアクセスする権限があるため、セキュリティリスクが高くなります。したがって、Alibaba Cloud アカウントを使用してオンラインで API をデバッグすることは推奨しません。API アクセスまたは日常業務には、RAM ユーザーを作成して使用することを強く推奨します。API 呼び出しを行う前に、ビジネス要件に基づいて必要に応じて RAM ユーザーに権限を付与してください。RAM ユーザーには、Lindorm を操作する権限が必要です。詳細については、「認可情報」をご参照ください。
ユーザーアイデンティティ | サポート |
はい | |
RAM ユーザー (推奨) | はい |
RAM ロール (推奨) | はい |
統合方法
Lindorm は、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 は、OpenAPI の実装の詳細を抽象化し、アイデンティティ、認証、および署名ルールを標準化します。SDK を統合するだけで、OpenAPI 操作を直接呼び出すことができます。Alibaba Cloud SDK の詳細については、「Alibaba Cloud SDK」をご参照ください。
-
Alibaba Cloud SDK を使用して、Lindorm の OpenAPI を呼び出すことができます。サポートされている言語と依存関係のインストール方法については、SDK のインストール をご参照ください。
Alibaba Cloud CLI
-
Alibaba Cloud CLI は、コマンドラインシェルで
aliyunコマンドを使用して Alibaba Cloud サービスとやり取りし、クラウドリソースを管理できるコマンドラインツールです。Alibaba Cloud CLI の詳細については、「Alibaba Cloud CLI とは」をご参照ください。 -
Alibaba Cloud CLI を使用して、Lindorm OpenAPI を呼び出すことができます。詳細については、「RPC API の呼び出し」をご参照ください。
Resource Orchestration Service (ROS)
-
ROS は、クラウドリソースの管理を簡素化する Alibaba Cloud サービスです。テンプレートを作成して、ECS インスタンスや RDS データベースインスタンスなど、必要な Alibaba Cloud リソースとその依存関係を定義できます。その後、ROS オーケストレーションエンジンが、テンプレートに基づいてすべてのリソースを自動的に作成および設定し、自動化されたデプロイと運用管理を実現します。詳細については、「ROS とは」をご参照ください。
-
Resource Orchestration Service (ROS) を使用して、Lindorm をオーケストレーションできます。サポートされている標準リソースとデータリソースのリストについては、「リソースオーケストレーションリスト」をご参照ください。
カスタムカプセル化 (非推奨)
または、独自のリクエストラッパーを構築して Alibaba Cloud OpenAPI にアクセスすることもできます。この方法では、V3 署名アルゴリズムを実装し、カスタムリクエストを構築して、HTTP 経由で送信する必要があります。署名メカニズムの詳細については、「V3 リクエスト本文と署名メカニズム」をご参照ください。
注意事項
API 呼び出しがエラーを返した場合は、返されたエラーコードを確認し、リクエストパラメータとその値を見直してください。詳細については、エラーコードセンター をご参照ください。
また、返された RequestID または SDK エラーメッセージを記録し、Alibaba Cloud OpenAPI 診断プラットフォーム を使用して問題を診断することもできます。