Alibaba Cloud CLI の使用開始 - Alibaba Cloud CLI - Alibaba Cloud ドキュメントセンター

このトピックでは、Alibaba Cloud CLI のインストール、認証情報の設定、コマンドの生成と実行など、Alibaba Cloud CLI を使用して API 操作を呼び出す方法について説明します。

概要

Alibaba Cloud CLI を使用して API 操作を呼び出すには、次の手順を実行します。

ご利用のデバイスのオペレーティングシステムに基づいて Alibaba Cloud CLI のバージョンを選択し、インストールします。
AccessKey ペアなどの ID 認証情報やリージョン ID を含む認証情報を Alibaba Cloud CLI で設定します。Alibaba Cloud CLI は、設定した認証情報を使用して API 操作を呼び出します。
OpenAPI Explorer でパラメーターを指定して、指定したパラメーターを含むサンプル CLI コマンドを生成します。そのコマンドをコピーします。
コマンドをシェルツールに貼り付け、ビジネス要件に基づいてコマンドオプションを指定します。コマンドを実行して、対応する API 操作を呼び出します。

前提条件

Alibaba Cloud アカウントが作成済みであること。Alibaba Cloud 公式サイトで Alibaba Cloud アカウントを作成できます。API 操作を呼び出すには、RAM ユーザーを作成することを推奨します。詳細については、「RAM ユーザーの作成」をご参照ください。
API 操作を呼び出す Alibaba Cloud サービスが有効化されていること。必要な Alibaba Cloud サービスを有効化するには、次のいずれかの方法を使用します。この例では、Short Message Service (SMS) が有効化されています。
- ユーザーセンターコンソールにログインします。サービス有効化ページで SMS を検索し、SMS の前のチェックボックスをオンにして、[有効化] をクリックします。
- 有効化したい各 Alibaba Cloud サービスのコンソールにログインします。たとえば、SMS コンソールにログインし、SMS コンソールの有効化ページで [今すぐ有効化] をクリックします。
API 操作を呼び出す Alibaba Cloud サービスが Alibaba Cloud CLI をサポートしていること。Alibaba Cloud サービスが Alibaba Cloud CLI をサポートしているかどうかを確認するには、次のいずれかの操作を実行します。
- Alibaba Cloud サービスのドキュメントを表示し、[デベロッパーリファレンス] > [API 統合の概要] を選択して、その Alibaba Cloud サービスが Alibaba Cloud CLI をサポートしているか確認します。
- Alibaba Cloud が提供する Cloud Shell で aliyun --help コマンドを実行して、Alibaba Cloud CLI をサポートする Alibaba Cloud サービスのリストをクエリします。

ステップ 1：Alibaba Cloud CLI のインストール

Alibaba Cloud CLI を使用する前に、インストールする必要があります。Alibaba Cloud CLI は、Windows、Linux、macOS をサポートしています。Alibaba Cloud CLI をインストールする際は、ご利用のデバイスのオペレーティングシステムに基づいてインストールパッケージを選択してください。詳細については、次のトピックをご参照ください。

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

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

重要

アカウントのセキュリティを確保するため、RAM ユーザーを作成し、その RAM ユーザーの認証情報を取得することを推奨します。詳細については、「認証情報のセキュリティソリューション」をご参照ください。

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

RAM ユーザーを作成し、ビジネス要件に基づいて Alibaba Cloud サービスを管理する権限を RAM ユーザーに付与します。詳細については、「RAM ユーザーの作成」および「RAM ユーザーへの権限付与」をご参照ください。
RAM ユーザーの AccessKey ペアを作成し、認証情報の設定のために AccessKey ID と AccessKey secret を記録します。詳細については、「AccessKey ペアの作成」トピックの「RAM ユーザーの AccessKey ペアの作成」セクションをご参照ください。
認証情報の設定のために、利用可能なリージョンの ID を取得して記録します。Alibaba Cloud CLI は、指定されたリージョン ID を使用して API 呼び出しを開始します。利用可能なリージョンの詳細については、「リージョンとゾーン」をご参照ください。
説明
Alibaba Cloud CLI を使用する場合、--region オプションを使用して、特定のリージョンでコマンドを実行できます。このオプションを使用すると、Alibaba Cloud CLI はデフォルトの認証情報設定および環境変数設定のリージョン情報を無視します。詳細については、「コマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey ペアを使用して、AkProfile という名前の設定ファイルで AccessKey 認証情報を設定します。詳細については、「プロファイルの設定」トピックの「設定例」セクションをご参照ください。

ステップ 3：コマンドの生成

説明

OpenAPI Explorer を使用すると、Alibaba Cloud CLI のすべてのコマンドをオンラインで生成できます。この方法で必要なサンプルコマンドを取得することを推奨します。詳細については、「コマンドの生成」をご参照ください。

デバッグページの左側の検索ボックスで、呼び出したい API 操作を検索します。API 操作の [パラメーター] タブで、API リファレンスに基づいてパラメーターを指定します。[パラメーター] タブの右側にある [CLI の例] タブをクリックして、指定したパラメーターを含む生成されたサンプルコマンドを表示します。

[コマンドの実行] アイコンをクリックして Cloud Shell を起動し、Cloud Shell でコマンドをデバッグします。
アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。サンプルコマンドをシェルツールに貼り付けて実行できます。
- サンプルコマンドをシェルツールに貼り付ける際は、パラメーターのフォーマットに注意してください。Alibaba Cloud CLI のパラメーターフォーマットの詳細については、「パラメーターのフォーマット」をご参照ください。
- デフォルトでは、OpenAPI Explorer は生成された CLI コマンドに --region オプションを追加します。コマンドをローカルのシェルにコピーすると、Alibaba Cloud CLI はデフォルトの ID 認証情報設定および環境変数設定のリージョン情報を無視し、指定されたリージョンを優先してコマンドを実行します。ビジネス要件に基づいて、このオプションを削除または保持できます。

ステップ 4：API 操作の呼び出し

構文

Alibaba Cloud CLI では、次のコードブロックに示す構文を使用してコマンドを実行できます。詳細については、「CLI コマンドの生成と実行」をご参照ください。

aliyun <command> <subcommand> [options and parameters]

コマンドオプション

Alibaba Cloud CLI を使用する際、コマンドオプションを指定してコマンドの動作を変更したり、コマンドの追加機能を利用したりできます。よく使用されるコマンドオプションは次のとおりです。

--profile <profileName>：--profile オプションと profileName パラメーターを使用して、設定プロファイルを指定できます。有効な設定プロファイルを指定すると、Alibaba Cloud CLI はデフォルトの認証情報設定および環境変数設定の情報を無視し、指定した設定を優先してコマンドを実行します。
--help：--help オプションを使用して、コマンドのヘルプ情報を取得できます。詳細については、「ヘルプコマンドの使用」をご参照ください。

詳細については、「コマンドラインオプション」をご参照ください。

コマンドの実行

サンプルコマンドが生成されたら、それをコピーしてシェルツールに貼り付けて実行します。たとえば、次のコマンドを実行して、Elastic Compute Service の CreateInstance 操作を呼び出し、従量課金の ECS インスタンスを作成します。

aliyun ecs CreateInstance
    --InstanceName myvm1
    --ImageId centos_7_03_64_40G_alibase_20170625.vhd
    --InstanceType ecs.n4.small
    --SecurityGroupId sg-xxxxxx123
    --VSwitchId vsw-xxxxxx456
    --InternetChargeType PayByTraffic
    --Password xxx

コマンドの実行方法の詳細については、「CLI コマンドの生成と実行」トピックの「例」セクション、または各 Alibaba Cloud サービスの CLI 統合の例 トピックをご参照ください。