すべてのプロダクト
Search
ドキュメントセンター

Data Management:Alibaba Cloud CLIとの統合

最終更新日:Oct 16, 2024

Alibaba Cloud CLIは、APIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、データ管理 (DMS) のデータ管理を自動化できます。 このトピックでは、Alibaba Cloud CLIを使用してDMSのAPI操作を呼び出す方法の例を示します。

あなたが始める前に

Alibaba Cloud CLIに精通してください。 詳細については、「Alibaba Cloud CLI の概要」をご参照ください。

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

Alibaba Cloud CLIのインストール

Alibaba Cloudが提供するCloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。 Cloud Shellの詳細については、「Cloud Shellとは」をご参照ください。

Alibaba Cloud CLI の設定

重要

Alibaba Cloudアカウントには、すべてのAlibaba CloudサービスのAPI操作を管理およびアクセスする権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーとして、API操作を呼び出すか、通常のO&M操作を実行することを推奨します。

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を設定する必要があります。 Alibaba Cloud CLIは、さまざまなID資格情報をサポートしています。 詳細については、「プロファイルの設定」トピックの「資格情報の種類」セクションをご参照ください。 この例では、AccessKey資格情報が使用されます。 以下の手順を実行します。

  1. RAMユーザーを作成し、ビジネス要件に基づいてAlibaba Cloudサービスを管理する権限をRAMユーザーに付与します。 詳細については、「RAMユーザーの作成」および「RAMユーザーへの権限付与」をご参照ください。 この例では、次の権限が付与されています。

    • AliyunDMSFullAccess: DMSリソースを管理するための権限。

    • AliyunCloudShellFullAccess: オプション。 Cloud Shellを管理するための権限。

      説明

      Cloud Shell provided by Alibaba Cloudを使用する場合、RAMユーザーに AliyunCloudShellFullAccess権限を付与します。

  2. RAMユーザーのAccessKeyペアを作成し、その後のID資格情報の設定のためにAccessKey IDAccessKey secretを記録します。 詳細については、「AccessKeyペアの作成」をご参照ください。

  3. リージョンIDを指定します。 Alibaba Cloud CLIは、指定されたリージョンでAPI操作を呼び出します。 使用可能なリージョンの詳細については、「エンドポイント」をご参照ください。

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

CLIコマンドの生成

  1. OpenAPI Explorerにログインします。

  2. APIデバッグページの左側の検索ボックスで、呼び出すAPI操作を検索します。

  3. API操作の [パラメーター] タブで、API参照に基づいてパラメーターを指定します。 右側の [CLIの例] タブをクリックして、指定されたパラメーターを含む生成されたサンプルコマンドを表示します。

    image

    • [CloudShellでコマンドを実行] アイコンをクリックして、Cloud Shellでコマンドをデバッグします。

    • [コピー] アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。 サンプルコマンドをローカルシェルに貼り付けて実行することもできます。

      説明
      • デバッグのためにサンプルコマンドをローカルシェルに貼り付ける場合は、パラメータの形式に注意してください。 Alibaba Cloud CLIコマンドのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。

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

サンプルコード

次のサンプルコードは、Alibaba Cloud CLIを使用してDMSのUpdateUser操作を呼び出し、ユーザーのシステムロールを更新します。 詳細については、「CLIコマンドの生成と実行」トピックの「コマンドの生成」セクションをご参照ください。

  1. 以下のコマンドを実行します。

    aliyun dms-enterprise UpdateUser --region cn-hangzhou --Uid 21400447956867**** --RoleNames 'ADMIN,DBA'
  2. 結果を表示します。

    {
            "RequestId": "B94173EF-0AEE-5B38-84A9-E6BDEF2B84F3",
            "Success": true
    }