ApsaraDB for MongoDBは、ApsaraDB for MongoDBコンソールを提供します。 ApsaraDB for MongoDBは、API操作、SDK、Alibaba Cloud CLIなどの複数の統合方法も提供します。 ビジネス要件に合った統合方法を選択できます。ApsaraDB for MongoDB
API操作
Alibaba Cloudは、API操作の学習と使用に役立つOpenAPI Explorerを提供しています。 OpenAPI Explorerは、API操作の使用に関連する次の機能を提供します: インテリジェント検索、ドキュメント、オンラインデバッグ、SDK、サンプルコード、エラー診断、および統計。 OpenAPI Explorerでは、Alibaba CloudサービスのAPI操作を呼び出し、リクエストとレスポンスを表示できます。 さらに、OpenAPI Explorerは、対応するSDKサンプルコードを自動的に生成し、Alibaba Cloudサービスの使用を容易にします。 詳細については、「APIとは何ですか?」をご参照ください。
APIバージョン
Alibaba CloudサービスのAPI操作のバージョン番号は、メジャーバージョンを示します。 たとえば、ApsaraDB for MongoDBのAPI操作の現在のバージョン番号は2015-12-01
です。 バージョン番号は日付のように見えるかもしれませんが、そうではありません。 API操作が2015年12月1日以降に更新されていないことを示すものではありません。
APIバージョン番号 | 説明 |
(推奨) |
オンラインデバッグ
ApsaraDB for MongoDBは、OpenAPI ExplorerでのAPIデバッグなどの機能を提供します。 API操作を呼び出す前に、ApsaraDB for MongoDBが提供するAPI操作のバージョン、エンドポイント、スタイル、呼び出し方法をよく知っている必要があります。
デバッグページ
次の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エンドポイントには、対応するAlibaba CloudリージョンのVPC内でのみアクセスできます。 VPCエンドポイントには次の利点があります。
高いセキュリティ: VPCエンドポイントはVPC内でのみアクセス可能で、高いセキュリティとプライバシーを提供します。
応答速度の高速化: VPCエンドポイントは内部ネットワークで実行されます。 したがって、エンドポイントはインターネットサービスよりも高速な応答速度を提供し、インターネットの待ち時間や帯域幅の制限などの問題を防止します。
低コスト: VPCエンドポイントは、通信に内部ネットワークを使用できます。
詳細については、「エンドポイント」をご参照ください。
サポートされるID
Alibaba Cloudアカウントを使用してOpenAPI Explorerにログインすると、OpenAPI ExplorerはデフォルトでオンラインOpenAPIデバッグにアカウントを使用します。 Alibaba Cloudアカウントには、すべてのAPI操作に対する権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーとしてAPI操作を呼び出すか、ルーチンのO&Mを実行することを推奨します。 RAMユーザーとしてAPI操作を呼び出す前に、ビジネス要件に基づいて必要な権限をRAMユーザーに付与します。 RAMユーザーには、ApsaraDB for MongoDBインスタンスで操作を実行する権限が付与されている必要があります。 詳細については、「RAMを使用したアクセス制御の実装」をご参照ください。 次の表に、サポートされるユーザーIDを示します。
ユーザーID | 対応 |
課金されます | |
RAMユーザー (推奨) | 課金されます |
RAMロール (推奨) | 課金されます |
統合方法
ApsaraDB for MongoDBは、SDKやAlibaba Cloud CLIなどの複数の統合方法を提供します。 ビジネスシナリオに適した統合方法を選択できます。
統合方法 | 対応 |
Alibaba Cloud SDK (推奨) | 課金されます |
課金されます | |
課金されます | |
課金されます | |
課金されます |
SDK
Alibaba Cloudは、Java、C# 、Go、Python、TypeScript、Node.js、PHP、C ++ などの複数のプログラミング言語でSDKを提供しています。 SDKと統合されたアプリケーションは、API操作を直接呼び出すことができます。 SDKは、署名ロジック、タイムアウトメカニズム、および再試行メカニズムなどの情報をカプセル化し、仕様に基づいて構造化応答オブジェクトを返します。 これは開発者に便利です。 詳細は、「Alibaba Cloud SDK」をご参照ください。
OpenAPI Explorerを使用して、SDKを使用してApsaraDB for MongoDBインスタンスを管理できます。 サポートされているプログラミング言語と依存関係のインストール方法の詳細については、 SDK for Javaの使用例をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud CLIでは、
aliyun
コマンドを実行してAlibaba Cloudサービスと対話し、クラウドサービスリソースを管理できます。 詳細については、「Alibaba Cloud CLIとは」をご参照ください。Alibaba Cloud CLIを使用して、ApsaraDB for MongoDBが提供するAPI操作を呼び出すことができます。 詳細については、「RPCおよびRESTfulスタイルでのAPIの呼び出し」をご参照ください。
Alibaba Cloud CLIを使用してApsaraDB for MongoDB」をご参照ください。
Terraform
Terraformは、クラウドインフラストラクチャとリソースを安全かつ効率的にプレビュー、設定、管理するために使用されるオープンソースツールです。 Resource Orchestration Service (ROS) と同様に、Terraformはテンプレートを内部データに変換し、API呼び出しを完了します。 詳細については、「Terraformとは何ですか?」をご参照ください。
Terraformを使用してApsaraDB for MongoDBリソースを調整する方法の詳細については、「TerraformによるApsaraDB for MongoDBの統合」をご参照ください。
ROS
ROSは、クラウドコンピューティングリソースの管理を簡素化できるAlibaba Cloudサービスです。 Elastic Compute Service (ECS) やApsaraDB RDSインスタンスなどの必要なAlibaba Cloudリソース、およびリソース間の依存関係を定義するためのテンプレートを作成できます。 ROSエンジンは、テンプレートに基づいてスタック内のすべてのリソースを自動的に作成および構成して、自動デプロイとO&Mを実装します。詳細については、「ROSとは何ですか?」をご参照ください。
ROSを使用して、ApsaraDB for MongoDBが提供するAPI操作を呼び出すことができます。 オーケストレーション用のリソースには、インスタンスの作成やクローン作成などの共通リソースと、作成可能なインスタンスの詳細やインスタンスタイプの照会などのデータリソースが含まれます。
共通リソース:
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リソースを調整する方法の詳細については、「ROSを使用したApsaraDB for MongoDBの統合」をご参照ください。
カスタムカプセル化
上記の方法のいずれもビジネス要件を満たしていない場合は、APIリクエストを手動でカプセル化できます。 ただし、この方法はお勧めできません。 詳細については、「リクエスト構文と署名メソッドV3」をご参照ください。
使用上の注意
APIを呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとパラメーター値が有効かどうかを確認します。 詳細については、次をご参照ください: ApsaraDB for MongoDB-エラーコード
Alibaba Cloud OpenAPI Diagnosticsプラットフォームを使用して、返されたリクエストIDまたはSDKエラー情報に基づいてセルフサービス診断を実行します。