Data Management (DMS) は、ビジュアルコンソールと、OpenAPI オンラインデバッグ、Alibaba Cloud SDK、Alibaba Cloud CLI を介したプログラムによるアクセスを提供します。DMS を使用して効率的に構築するには、要件に最も適した統合方法を選択してください。
OpenAPI の概要
Alibaba Cloud は、クラウド製品の OpenAPI を効率的に学習して使用できるように、OpenAPI Web サイトを提供しています。これは、インテリジェントな検索、ドキュメント、オンラインデバッグ、SDK へのアクセス、コードサンプル、エラー診断、呼び出し統計などの機能を備えたオールインワンプラットフォームです。OpenAPI ポータルを使用して、さまざまな Alibaba Cloud 製品の OpenAPI を呼び出し、リクエストとレスポンスを表示できます。このポータルは、Alibaba Cloud 製品をすぐに使い始められるように、SDK コードサンプルも自動的に生成します。詳細については、「OpenAPI とは」をご参照ください。
API バージョン
Alibaba Cloud OpenAPI は、バージョン番号を使用して、クラウド製品の主要な API バージョンを管理します。
たとえば、DMS は API バージョン 2018-11-01 をサポートしています。文字列 2018-11-01 は API バージョンの識別子であり、日付ではありません。これは最新の API 機能へのアクセスを提供し、API が 2018-11-01 以降更新されていないことを示すものではありません。
|
機能 |
API バージョン |
説明 |
|
DMS |
推奨。 |
オンラインデバッグ
DMS は、OpenAPI ポータルで API デバッグやその他の機能を提供します。API 呼び出しを行う前に、DMS が提供するバージョン、エンドポイント、API スタイル、およびリクエストメソッドを理解する必要があります。
OpenAPI ポータルのデバッグページでは、左側メニューに ListInstances (インスタンス情報の一覧を取得)、AddInstance、ModifyInstance、GetInstance、DeleteInstance などの API オペレーションが表示されます。API オペレーションを選択すると、中央のパネルで [China (Hangzhou)] などのエンドポイントやリクエストパラメーターを設定できます。これらのパラメーターには、Tid (テナント ID)、SearchKey (検索キーワード)、DbType (データベースタイプ)、EnvType (環境タイプ)、InstanceSource (インスタンスソース)、NetType (ネットワークタイプ)、InstanceState (インスタンス状態)、PageNumber (ページ番号) が含まれます。値を入力した後、[Initiate Call] をクリックしてリクエストを送信します。右側のドキュメントパネルには、各パラメーターのデータ型と値の例が表示されます。
デバッグのエントリーポイント
|
機能 |
API バージョン |
エントリーポイント |
|
DMS |
エンドポイント
DMS
レイテンシーを最小限に抑えるために、リソースが配置されているリージョンに対応するエンドポイントを選択します。
たとえば、中国 (張家口) リージョンの VPC エンドポイントは dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com です。詳細については、「エンドポイント」をご参照ください。
サポートされる ID
Alibaba Cloud アカウントで OpenAPI Web サイトにログインすると、デフォルトでオンラインデバッグのためにこのアカウントを使用して API 呼び出しが行われます。Alibaba Cloud アカウントは完全な権限を持つため、日常の API アクセスに使用するのはリスクが高いです。日常の操作には RAM ユーザーを作成して使用することを強く推奨します。API 呼び出しを行う前に、ビジネスニーズに基づいて RAM ユーザーに権限を付与してください。RAM ユーザーは DMS を操作するために必要な権限を持っている必要があります。詳細については、「RAM を使用したアクセス制御」をご参照ください。
|
ユーザー ID |
サポート |
|
サポート |
|
|
RAM ユーザー (推奨) |
サポート |
|
RAM ロール (推奨) |
サポート |
統合方法
統合の概要
DMS は、SDK を含む複数の統合方法を提供しています。ビジネスニーズに最も適した方法を選択できます。
SDK は統合が容易であり、OpenAPI の呼び出しに推奨される方法です。
DMS
|
方法 |
サポート |
|
Alibaba Cloud SDK (推奨) |
サポート |
|
サポート |
|
|
一部サポート |
|
|
サポート対象外 |
|
|
カスタム API カプセル化 (非推奨) |
サポート |
Alibaba Cloud SDK
-
Alibaba Cloud は、Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ など、複数のプログラミング言語用の SDK を提供しています。SDK を統合するだけで、公開されたメソッドを通じて OpenAPI を直接呼び出すことができます。SDK は、署名ロジック、タイムアウト、再試行メカニズムを処理し、構造化されたレスポンスオブジェクトを返すことで、開発を簡素化します。Alibaba Cloud SDK の詳細については、「Alibaba Cloud SDK」をご参照ください。
-
DMS SDK でサポートされている言語と依存関係については、「DMS SDK」をご参照ください。
Alibaba Cloud CLI
-
Alibaba Cloud CLI を使用すると、ターミナルから
aliyunコマンドを使用して Alibaba Cloud サービスと対話し、クラウドリソースを管理できます。Alibaba Cloud CLI の詳細については、「Alibaba Cloud CLI とは」をご参照ください。 -
Alibaba Cloud CLI を使用して DMS API オペレーションを呼び出すことができます。詳細については、「Alibaba Cloud CLI を使用した RPC API オペレーションの呼び出し」をご参照ください。
Resource Orchestration Service (ROS)
-
ROS は、クラウドリソースの管理を簡素化する Alibaba Cloud サービスです。開発者と管理者は、テンプレートを記述して、Elastic Compute Service (ECS) インスタンスや Relational Database Service (RDS) データベースインスタンスなどの必要な Alibaba Cloud リソースとその依存関係を定義できます。ROS オーケストレーションエンジンは、テンプレートに基づいてすべてのリソースを自動的に作成および設定し、自動デプロイと運用保守を可能にします。詳細については、「Resource Orchestration Service とは」をご参照ください。
-
ROS を使用して DMS リソースをオーケストレーションできます。以下の DMS リソースがサポートされています。
-
ALIYUN::DMS::Instance：新しいインスタンスを登録します。
-
ALIYUN::DMS::User：新しいユーザーを登録します。
-
-
ROS を使用して DMS リソースを迅速にオーケストレーションするには、「ROS 統合例」をご参照ください。
カスタム API カプセル化
ネイティブな HTTP 呼び出しを行うには、署名アルゴリズムを実装し、カスタムリクエストを構築し、HTTP 呼び出しを開始する必要があります。署名メカニズムの詳細については、「DMS API の概要」および「リクエストボディと署名メカニズム (V3)」をご参照ください。
注意事項
DMS
-
API 呼び出しが失敗した場合は、返されたエラーコードを使用してリクエストパラメーターとその値を確認してください。詳細については、「エラーコード」をご参照ください。
-
または、レスポンスから RequestID または SDK エラーメッセージを記録し、Alibaba Cloud OpenAPI Diagnostics を使用して問題をトラブルシューティングしてください。