データ管理 (DMS) は視覚化された操作コンソールを提供し、Alibaba Cloud SDKまたはAlibaba Cloud CLIを使用してオンラインAPIデバッグを実行し、DMS API操作を呼び出すことができます。 DMSでの開発効率を向上させるために、ビジネス要件に基づいて適切な運用および統合方法を選択することを推奨します。
DMS APIの概要
Alibaba Cloudは、Alibaba CloudサービスのAPIを効率的に学習および使用するためのOpenAPI Explorerを提供しています。 OpenAPI Explorerは、インテリジェント検索、ドキュメント、オンラインデバッグ、SDKダウンロード、サンプルコード、エラー診断、呼び出し統計など、API操作に関連する複数の機能を統合しています。 OpenAPI Explorerでは、Alibaba CloudサービスのAPI操作を呼び出し、APIのリクエストとレスポンスを表示できます。 さらに、OpenAPI Explorerは、対応するSDKサンプルコードを自動的に生成し、Alibaba Cloudサービスの使用を容易にします。 詳細については、「APIとは何ですか?」をご参照ください。
サポートされているバージョン
Alibaba Cloud APIは、バージョン番号を使用してクラウドサービスAPIのバージョンを管理します。
たとえば、DMSは2018-11-01バージョンのAPIをサポートしています。 2018-11-01は、日付ではなくAPIバージョン番号です。 ユーザーには、APIに関する最新の公開情報が提供されます。 2018-11-01 DMS APIの最新バージョンです。
API バージョン | 説明 |
このバージョンのAPI操作を使用することを推奨します。 |
APIスタイル
DMS API操作は、リモートプロシージャ呼び出し (RPC) モードで呼び出されます。
オンラインデバッグ
DMSは、OpenAPI ExplorerのAPIデバッグなどの機能を提供します。 API操作を呼び出す前に、DMSが提供する次の情報 (APIのバージョン、エンドポイント、APIスタイル、およびリクエストメソッド) を理解する必要があります。
デバッグ
APIデバッグは、 https://api.alibabacloud.com/api/dms-enterprise/2018-11-01/ で操作できます。
エンドポイント
リソースが存在するリージョンに基づいてエンドポイントを選択し、レイテンシを削減します。
たとえば、インスタンスが中国 (張家口) リージョンにあり、仮想プライベートクラウド (VPC) にデプロイされている場合、エンドポイントとしてdms-enterprise-vpc.cn-zhangjiakou.aliyuncs.comを指定します。 詳細については、「エンドポイント」をご参照ください。
サポートされるID
デフォルトでは、Alibaba Cloudアカウントを使用してOpenAPI Explorerにログインすると、Alibaba Cloudアカウントを使用してオンラインデバッグが実行されます。 Alibaba Cloudアカウントには、すべてのAPI操作に対する権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーとしてAPI操作を呼び出すか、ルーチンのO&Mを実行することを強くお勧めします。 RAMユーザーとしてAPI操作を呼び出す前に、ビジネス要件に基づいて必要な権限をRAMユーザーに付与します。 RAMユーザーには、DMSを使用するために必要な権限が必要です。 詳細については、「RAMを使用したアクセス制御の実装」をご参照ください。
ユーザーID | 対応 |
必須 | |
RAMユーザー (推奨) | 必須 |
RAMロール (推奨) | 必須 |
統合方法
統合の概要
ビジネス要件に基づいてSDKなどのさまざまな統合方法を使用して、DMSをビジネスシステムと統合できます。
SDKは簡単に統合できるため、SDKはAPI操作を呼び出すために最も推奨される方法です。
方式 | 対応 |
Alibaba Cloud SDK (推奨) | 必須 |
必須 | |
はい (一部サポート) | |
任意 | |
カスタムAPIカプセル化 (非推奨) | 必須 |
Alibaba Cloud SDK
Alibaba Cloudは、Java、C# 、Go、Python、TypeScript + Node.js、PHP、C ++ などの複数のプログラミング言語でSDKを提供しています。 SDKをビジネスシステムと統合して、API操作を直接呼び出すことができます。 SDKは、署名ロジック、タイムアウトメカニズム、再試行メカニズムなどの情報をカプセル化し、仕様に基づいて構造化応答オブジェクトを返します。 詳細は、「Alibaba Cloud SDK」をご参照ください。
DMS SDKでサポートされているプログラミング言語と依存関係については、「DMS SDK」をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud CLIでは、
aliyunコマンドを使用して他のAlibaba Cloudサービスと対話し、Alibaba Cloudリソースを管理できます。 詳細については、「」をご参照ください。Alibaba Cloud CLIとはAlibaba Cloud CLIを使用して、DMSのAPI操作を呼び出すことができます。 詳細については、「RPC APIおよびRESTful APIの呼び出し」をご参照ください。
ROS
ROSは、クラウドコンピューティングリソースの管理を簡素化できるAlibaba Cloudサービスです。 スタックテンプレートをコンパイルして、ECS (Elastic Compute Service) やApsaraDB RDSインスタンスなどのクラウドコンピューティングリソース、およびテンプレート内のリソース間の依存関係を記述できます。 ROSエンジンは、テンプレートに基づいてスタック内のすべてのリソースを自動的に作成および構成して、自動デプロイとO&Mを実装します。詳細については、「」をご参照ください。ROSとは何ですか?
ROSを使用してDMSのAPI操作を呼び出すことができます。 ROSでは、次のDMS固有のリソースタイプがサポートされています。
ALIYUN::DMS::Instance: DMSにインスタンスを登録します。
ALIYUN::DMS::User: DMSユーザーを追加します。
ROSを使用してDMSリソースを効率的に調整する方法の詳細については、こちらをご覧ください。
カスタムAPIカプセル化
ネイティブHTTP呼び出しを行うには、カスタムリクエストを作成してリクエストに署名する必要があります。 署名メソッドの詳細については、「関数別の操作の一覧」および「リクエスト構文と署名メソッドV3」をご参照ください。
使用上の注意
API操作呼び出しでエラーが返された場合は、エラーコードに基づいてリクエスト内のパラメーターと値を確認します。 エラーコードの詳細については、「エラーコード」をご参照ください。
Alibaba Cloud OpenAPI Diagnosticsを使用して、返されたリクエストIDまたはSDKエラー情報に基づいてセルフサービス診断を実行することもできます。