すべてのプロダクト
Search

このプロダクト

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

    ドキュメントセンター

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

    最終更新日:Apr 16, 2025

    このトピックでは、Alibaba Cloud CLI を使用して API 操作を呼び出す方法について説明します。これには、Alibaba Cloud CLI のインストール方法、資格情報の構成方法、およびコマンドの生成方法と実行方法が含まれます。

    概要

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

    1. デバイスのオペレーティングシステムに基づいて、Alibaba Cloud CLI のバージョンを選択してインストールします。

    2. Alibaba Cloud CLI で資格情報を構成します。これには、AccessKey ペアなどの ID 資格情報とリージョン ID が含まれます。Alibaba Cloud CLI は、構成した資格情報を使用して API 操作を呼び出します。

    3. OpenAPI エクスプローラーでパラメーターを指定して、指定したパラメーターを含むサンプル CLI コマンドを生成します。コマンドをコピーします。

    4. コマンドをシェルツールに貼り付け、ビジネス要件に基づいてコマンドオプションを指定します。コマンドを実行して、対応する API 操作を呼び出します。

    image

    前提条件

    • Alibaba Cloud アカウントが作成されていること。Alibaba Cloud 公式 Web サイトで Alibaba Cloud アカウントを作成できます。API 操作を呼び出すには、RAM ユーザーを作成することをお勧めします。詳細については、「RAM ユーザーを作成する」をご参照ください。

    • API 操作を呼び出す Alibaba Cloud サービスがアクティブ化されていること。次のいずれかの方法を使用して、必要な Alibaba Cloud サービスをアクティブ化できます。この例では、ショートメッセージサービス (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 ユーザーの ID 資格情報を取得することをお勧めします。詳細については、「資格情報のセキュリティソリューション」をご参照ください。

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

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

    2. RAM ユーザーの AccessKey ペアを作成し、ID 資格情報の構成のために AccessKey ID と AccessKey シークレット を記録します。詳細については、「AccessKey ペアを作成する」トピックの「RAM ユーザーの AccessKey ペアを作成する」セクションをご参照ください。

    3. ID 資格情報の構成のために、使用可能なリージョンの ID を取得して記録します。Alibaba Cloud CLI は、指定されたリージョン ID を使用して API 呼び出しを開始します。使用可能なリージョンの詳細については、「リージョンとゾーン」をご参照ください。

      説明

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

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

    手順 3：コマンドを生成するコマンド

    説明

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

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

    image

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

    • image アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。サンプルコマンドをシェルツールに貼り付けて、サンプルコマンドを実行できます。

      • サンプルコマンドをシェルツールに貼り付ける際は、パラメーターの形式に注意してください。Alibaba Cloud CLI のパラメーター形式の詳細については、「パラメーター形式」をご参照ください。

      • デフォルトでは、OpenAPI エクスプローラーは生成された 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 オプションを使用して、コマンドに関するヘルプ情報を取得できます。詳細については、「help コマンドを使用する」をご参照ください。

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

    コマンドを実行する

    サンプルコマンドが生成されたら、サンプルコマンドをコピーしてシェルツールに貼り付けて、コマンドを実行します。たとえば、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 統合の例] トピックをご参照ください。