Data Management:Alibaba Cloud CLIを使用してDMSのAPI操作を呼び出す

あなたが始める前に

Alibaba Cloud CLIは、APIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、Data Managementでリソースの管理とメンテナンスを自動化できます。 詳細については、「Alibaba Cloud CLIとは 」をご参照ください。

Alibaba Cloud CLIを使用して複雑なタスクのAPI操作を呼び出す場合は、コマンドをシェルスクリプトにコンパイルしてからシェルスクリプトを実行して効率を向上させることを推奨します。

手順1: Alibaba Cloud CLIのインストール

• Windows

• Linux

• macOS

Alibaba Cloud CLIはCloud Shellにプリインストールされています。 Cloud Shellは、ID資格情報を自動的に設定します。 Cloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグできます。 詳細については、「Cloud Shellとは 」をご参照ください。

ステップ2: Alibaba Cloud CLIの設定

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を指定する必要があります。 Alibaba Cloud CLIは、さまざまなタイプのID資格情報をサポートしています。 詳細については、「Credential types」トピックの「Credential types」セクションをご参照ください。 Alibaba Cloud CLIでは、RAMユーザーのAccessKeyペアを使用してID認証情報を設定できます。 RAMユーザーのAccessKeyペアを使用する場合は、次の手順を実行します。

1. RAMユーザーを作成し、RAMユーザーがID資格情報を設定するためのAccessKeyペアを作成します。 詳細については、「RAM ユーザーの作成」および「AccessKeyの作成」をご参照ください。

2. RAM ユーザーに必要な権限を付与します。 この例では、AliyunDMSFullAccessポリシーがRAMユーザーにアタッチされています。 ポリシーは、Data Managementリソースを管理する権限を付与します。 詳細については、「RAMユーザーへの権限付与」をご参照ください。

3. ID資格情報の設定に使用するリージョンのIDを取得します。 Alibaba Cloud CLIは、指定したリージョンIDを使用してAPI呼び出しを開始します。 Data Managementでサポートされているリージョンの詳細については、「エンドポイント」をご参照ください。

   説明

   Alibaba Cloud CLIを使用する場合、-- regionオプションを使用して、特定のリージョンでコマンドを実行できます。 このオプションを使用すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視します。 詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。

4. RAMユーザーのAccessKeyペアを使用して、AkProfileという名前の設定ファイルでAccessKey資格情報を設定します。 詳細については、「プロファイルの設定」トピックの「設定例」をご参照ください。

ステップ3: CLIコマンドを生成する

1. OpenAPI Explorerで、 UpdateUser操作。

   

2. [パラメーター] タブで、リクエストパラメーターを設定します。 次に、[CLIの例] タブをクリックして、生成されたサンプルCLIコマンドを表示します。

3. CLIコマンドをコピーするか、Cloud ShellでCLIコマンドをデバッグします。

   • アイコンをクリックしてCloud Shellでコマンドを実行します。 Cloud Shellウィンドウでコマンドをすばやくデバッグできます。

   • アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。 次に、サンプルコマンドをオンプレミスシェルに貼り付けて、サンプルコマンドを実行します。

   説明

   CLIコマンドをオンプレミスのシェルに貼り付けてデバッグするときは、パラメーターの形式に注意してください。 Alibaba Cloud CLIで必要なパラメーター形式については、「パラメーター形式」をご参照ください。

   デフォルトでは、OpenAPI Explorerは、生成されたCLIコマンドに -- regionオプションを追加します。 コマンドをローカルシェルにコピーすると、Alibaba Cloud CLIはデフォルトのID資格情報設定と環境変数設定のリージョン情報を無視し、指定されたリージョンを優先的に使用してコマンドを実行します。 このオプションは、ビジネス要件に基づいて削除または保持できます。

手順4: Data ManagementのAPI操作の呼び出し