ApsaraDB for MongoDBは、ビジュアルコンソールを提供し、API 操作、SDK、Alibaba Cloud CLI、Terraform、および ROS によるプログラム統合をサポートします。ApsaraDB for MongoDB
API オペレーション
Alibaba Cloud OpenAPI Explorer を使用すると、API オペレーションをオンラインで検索、デバッグ、呼び出ししたり、SDK サンプルコードを生成したりできます。 詳細については、「API とは」をご参照ください。
API バージョン
API バージョン番号はメジャーバージョンを示します。 ApsaraDB for MongoDB の現在のバージョンは 2015-12-01 です。 この番号は日付のような形式ですが、最終更新日を反映したものではありません。
|
API バージョン番号 |
説明 |
|
推奨 |
オンラインデバッグ
ApsaraDB for MongoDB は OpenAPI Explorer での API デバッグをサポートしています。API 操作を呼び出す前に、ApsaraDB for MongoDB でそのバージョン、エンドポイント、および呼び出しメソッドを確認してください。
例えば、CreateDBInstance API のページでは、左側に API カテゴリ、中央にパラメーターフォーム (RegionId、ZoneId、Engine、EngineVersion、DBInstanceClass、DBInstanceStorage など)、右側にリファレンスドキュメントが表示されます。 [Initiate Call] をクリックしてリクエストを実行します。
デバッグページ
次の URL で API オペレーションをデバッグします: https://api.alibabacloud.com/api/Dds/2015-12-01/。
エンドポイント
リソースのリージョンに基づいてエンドポイントを選択してください。 例えば、中国 (張家口) リージョンにあるApsaraDB for MongoDB インスタンスは、パブリックエンドポイント mongodb.cn-zhangjiakou.aliyuncs.com と VPC エンドポイント mongodb-vpc.cn-zhangjiakou.aliyuncs.com を使用します。
-
パブリックエンドポイントは全世界でアクセス可能です。
-
VPC エンドポイントは、対応するリージョンの VPC 内からのみアクセスでき、以下の利点があります:
-
セキュリティとプライバシーの向上。
-
パブリックインターネットのオーバーヘッドを回避することによる低レイテンシー。
-
内部ネットワーク通信による低コスト化。
-
詳細については、「エンドポイント」をご参照ください。
サポートされるアイデンティティ
OpenAPI Explorer は、デフォルトで Alibaba Cloud アカウントを使用してデバッグします。 Alibaba Cloud アカウントは完全な API 権限を持っているため、日常的な API 呼び出しや O&M には RAM ユーザーを使用することを推奨します。 RAM ユーザーには、ApsaraDB for MongoDB インスタンスに必要な権限を付与してください。 詳細については、「RAM を使用したアクセス制御の実装」をご参照ください。 次の表に、サポートされているユーザーアイデンティティを示します。
|
ユーザーアイデンティティ |
サポート |
|
はい |
|
|
RAM ユーザー (推奨) |
はい |
|
RAM ロール (推奨) |
はい |
統合方法
ApsaraDB for MongoDB は、以下の統合方法をサポートしています。
|
統合方法 |
サポート |
|
Alibaba Cloud SDK (推奨) |
はい |
|
はい |
|
|
はい |
|
|
はい |
|
|
はい |
SDK
-
Alibaba Cloud は、Java、C#、Go、Python、TypeScript、Node.js、PHP、C++ 向けの SDK を提供しています。 SDK は、署名ロジック、タイムアウト、リトライを処理し、構造化されたレスポンスオブジェクトを返します。 詳細については、「Alibaba Cloud SDK」をご参照ください。
-
OpenAPI Explorer は、ApsaraDB for MongoDB の API オペレーションを呼び出すための SDK サンプルコードを生成します。 サポートされている言語と依存関係:ApsaraDB for MongoDB SDK。
Alibaba Cloud CLI
-
Alibaba Cloud CLI を使用すると、
aliyunコマンドを実行してクラウドリソースを管理できます。 詳細については、「Alibaba Cloud CLI とは」をご参照ください。 -
Alibaba Cloud CLI を通じて ApsaraDB for MongoDB の API オペレーションを呼び出すことができます。 詳細については、「RPC および RESTful スタイルでの API の呼び出し」をご参照ください。
-
Alibaba Cloud CLI を使用して ApsaraDB for MongoDB の API オペレーションを呼び出すためのステップバイステップのウォークスルーについては、「CLI 統合の例」をご参照ください。
Terraform
-
Terraform は、クラウドインフラストラクチャのプレビュー、設定、管理を行うためのオープンソースツールです。 ROS と同様に、Terraform はテンプレートを API 呼び出しに変換します。 詳細については、「Alibaba Cloud Terraform とは」をご参照ください。
-
Terraform を使用して ApsaraDB for MongoDB リソースをオーケストレーションするためのステップバイステップのウォークスルーについては、「Terraform 統合の例」をご参照ください。
ROS
-
リソースオーケストレーションサービス (ROS) は、クラウドリソースの管理を簡素化する Alibaba Cloud のサービスです。 テンプレートを作成してリソース (ECS インスタンスや ApsaraDB RDS インスタンスなど) とその依存関係を定義すると、ROS が自動的にそれらを作成し、設定します。 詳細については、「リソースオーケストレーションサービスとは」をご参照ください。
-
ROS を使用して ApsaraDB for MongoDB を管理できます。 サポートされているリソースタイプ:
-
共通リソース:
-
ALIYUN::MONGODB::Instance: ApsaraDB for MongoDB インスタンスを作成します。
-
ALIYUN::MONGODB::ServerlessInstance: ApsaraDB for MongoDB サーバーレスインスタンスを作成します。
-
ALIYUN::MONGODB::ShardingInstance: ApsaraDB for MongoDB シャードクラスターインスタンスを作成またはクローンします。
-
-
データリソース:
-
DATASOURCE::MONGODB::Instances: ApsaraDB for MongoDB インスタンスを照会します。
-
DATASOURCE::MONGODB::InstanceClasses: ゾーンで利用可能な ApsaraDB for MongoDB インスタンスタイプを照会します。
-
-
-
ROS を使用して ApsaraDB for MongoDB リソースをオーケストレーションするためのステップバイステップのウォークスルーについては、「リソースオーケストレーション統合の例」をご参照ください。
カスタムカプセル化
前述のいずれの方法でも要件を満たせない場合は、手動で API リクエストをカプセル化できます。 この方法は推奨しません。 詳細については、「リクエスト構文と署名方法 V3」をご参照ください。
エラー処理
API 呼び出しでエラーが返された場合は、返されたエラーコードをエラーコードセンターで確認し、リクエストパラメーターを見直してください。
セルフサービスのトラブルシューティングには、レスポンスまたは SDK のエラー詳細から得られる RequestID をAlibaba Cloud OpenAPI Diagnostics プラットフォームで利用してください。