ApsaraDB RDS では、視覚的な操作が可能なコンソールに加え、OpenAPI Explorer、Alibaba Cloud SDK、Resource Orchestration Service (ROS) など、複数の API オペレーション呼び出し方法を提供しています。ご使用のワークフローに最も適した統合方法を選択してください。
OpenAPI Explorer の概要
OpenAPI Explorer は、開発者が Alibaba Cloud の各種サービスにわたる API オペレーションを検索し、使用するのに役立つ Alibaba Cloud のツールです。 インテリジェント検索、ドキュメント、オンラインデバッグ、SDK のダウンロード、サンプルコード、エラー診断、呼び出し統計などの機能を一元的に提供します。 OpenAPI Explorer を使用すると、API オペレーションの呼び出しや、リクエストと応答の確認ができます。 また、テストした操作の SDK サンプルコードも自動生成します。 詳細については、「API とは」をご参照ください。
バージョンの説明
ApsaraDB RDS では、API のバージョン管理にバージョン番号を使用します。現在推奨されているバージョンは 2014-08-15 です。なお、2014-08-15 は日付ではなく、バージョン識別子であることにご注意ください。
| バージョン | 説明 |
|---|---|
| 2014-08-15 | 推奨 |
オンラインデバッグ
OpenAPI Explorer では、ApsaraDB RDS の API デバッグをサポートしています。API オペレーションを呼び出す前に、利用可能なバージョン、エンドポイント、統合方法を確認してください。
オンラインデバッグページ
OpenAPI Explorer にアクセスします。
デバッグのエントリポイント： API のデバッグ
エンドポイント
レイテンシを低減するため、ご利用のインスタンスが配置されているリージョンに対応するエンドポイントを使用してください。たとえば、中国 (張家口) リージョンに配置されたインスタンスの場合、パブリックエンドポイントは rds.cn-zhangjiakou.aliyuncs.com、仮想プライベートクラウド (VPC) エンドポイントは rds-vpc.cn-zhangjiakou.aliyuncs.com となります。
パブリックエンドポイントはグローバルにアクセス可能です。
VPC エンドポイントは、パブリックエンドポイントと比較して以下の利点があります：
高いセキュリティ： VPC エンドポイントは VPC 内からのみアクセス可能であり、より高いセキュリティおよびプライバシーを実現します。
高速な応答： データは VPC ネットワーク上で送信されるため、レイテンシが低減され、帯域幅制限を回避できます。
低コスト： VPC エンドポイント経由のトラフィックは内部ネットワークを使用します。
詳細については、「エンドポイント」をご参照ください。
サポートされるユーザー識別子
デフォルトでは、OpenAPI Explorer はオンラインデバッグに Alibaba Cloud アカウントを使用します。Alibaba Cloud アカウントには、すべての API オペレーションに対する完全な権限があり、これはセキュリティリスクを招きます。代わりに、RAM ユーザーまたは RAM ロールを使用して API オペレーションを呼び出し、日常的な運用および保守 (O&M) を実行してください。RAM ユーザーを使用する前に、ApsaraDB RDS リソースを管理するために必要な権限を付与してください。詳細については、「RAM ユーザーに ApsaraDB RDS インスタンスの管理権限を付与する」をご参照ください。
| 識別子 | 対応状況 |
|---|---|
| Alibaba Cloud アカウント | はい |
| RAM ユーザー（推奨） | はい |
| RAM ロール（推奨） | はい |
参考情報
統合方法
ApsaraDB RDS では、Alibaba Cloud SDK、Alibaba Cloud CLI、ROS、Terraform、およびカスタムカプセル化による API 呼び出しがサポートされています。ご使用のワークフローに応じて、適切な方法を選択してください。
| 呼び出し方法 | 対応状況 |
|---|---|
| Alibaba Cloud SDK | はい |
| Alibaba Cloud CLI | はい |
| ROS | はい |
| Terraform | はい |
| カスタムカプセル化 | はい |
ほとんどのユースケースにおいて、統合が容易な SDK が推奨されます。
Alibaba Cloud SDK
Alibaba Cloud SDK は、Java、C#、Go、Python、TypeScript、Node.js、PHP、C++ に対応しています。SDK では、リクエスト署名、タイムアウト、再試行処理を自動的に処理し、構造化された応答オブジェクトを返すため、開発が簡素化されます。詳細については、「Alibaba Cloud SDK」をご参照ください。
ApsaraDB RDS でサポートされる言語および依存関係については、「OpenAPI Explorer」をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud CLI を使用すると、aliyun コマンドを実行して Alibaba Cloud サービスと対話し、クラウドリソースを管理できます。詳細については、「Alibaba Cloud CLI とは」をご参照ください。
Alibaba Cloud CLI を使用して ApsaraDB RDS の API オペレーションを呼び出す方法については、「コマンドの生成」をご参照ください。
ROS
Resource Orchestration Service (ROS) は、クラウドリソースの作成および構成を自動化するサービスです。Elastic Compute Service (ECS) インスタンスや ApsaraDB RDS インスタンスなど、インフラストラクチャの各リソースおよびそれらの関係をテンプレートで定義することで、ROS がすべてを自動的にプロビジョニングし、自動デプロイメントおよび運用・保守 (O&M) を実現します。詳細については、「ROS とは」をご参照ください。
ApsaraDB RDS で ROS がサポートするリソースおよびデータの型については、「ROS でサポートされる ApsaraDB RDS リソース」をご参照ください。
カスタムカプセル化による API 呼び出し
ネイティブ HTTP 呼び出しを行うには、リクエストを手動で作成し、署名します。 署名の詳細については、「関数別の操作一覧」および「リクエスト構文と署名メソッド V3」をご参照ください。
注意事項
API オペレーションがエラーを返した場合、エラーコードを確認し、入力パラメーターの妥当性を検証してください。エラーコードの一覧については、「共通エラーコード」をご参照ください。
リクエスト ID または SDK のエラー詳細を用いたセルフサービス診断には、「Alibaba Cloud OpenAPI 診断」をご利用ください。