OpenAPI Explorer で CLI コマンドを生成する - Alibaba Cloud CLI

Alibaba Cloud CLI は複数の Alibaba Cloud サービスをサポートしています。このトピックでは、Alibaba Cloud CLI コマンドを使用して、一般的に使用される API 操作を呼び出す方法と、OpenAPI Explorer で CLI コマンドを生成する方法について説明します。

前提条件

重要

一部の API 操作の呼び出しには料金が発生する場合があります。コマンドをデバッグする前に、必要な Alibaba Cloud サービスがアクティブになっていることを確認してください。また、これらのサービスの請求ルールと、これらのサービスの API 操作を呼び出す方法についても理解しておく必要があります。

ローカルでコマンドをデバッグする前に、Alibaba Cloud CLI をインストールし、ID 資格情報を正しく構成していることを確認してください。詳細については、「Installation Guide」および「ID 資格情報の構成」をご参照ください。
Alibaba Cloud サービスの API リファレンスと、対応する Alibaba Cloud CLI コマンドのサンプルコードは、サービス名に基づいて OpenAPI Explorer から入手できます。詳細については、このトピックの「コマンドの生成」セクションをご参照ください。

コマンドの生成

説明

OpenAPI Explorer では、すべての Alibaba Cloud CLI コマンドをオンラインで生成できます。 CLI コマンドを生成するには、次の手順を実行することをお勧めします。

手順 1：OpenAPI Explorer にログオンする

OpenAPI Explorer にログオンします。

手順 2：CLI コマンドを生成する API 操作を検索する

OpenAPI Explorer で API 操作を検索するには、次のいずれかの方法を使用します。

API 操作名で検索する

重要

Alibaba Cloud サービスによっては、同じ名前の API 操作を使用している場合があります。誤操作による損失を防ぐため、API 操作の名前を慎重に確認してください。

OpenAPI Explorer で、呼び出す API 操作の名前を上部または中央の検索ボックスに入力し、ポインターを API 操作の上に移動して、[デバッグ] をクリックします。

サービスコードで検索する

OpenAPI Explorer で、API 操作を呼び出す Alibaba Cloud サービスのコードを上部または中央の検索ボックスに入力し、ポインターをサービスの上に移動して、[API の表示] をクリックして、サービスのホームページに移動します。

OpenAPI Explorer の上部ナビゲーションバーにある [クラウドプロダクト] の上にポインターを移動し、API 操作が属する Alibaba Cloud サービスを検索して、サービスのホームページに移動することもできます。
サービスのホームページで、右上隅にある [デバッグ] をクリックします。

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

左側の検索ボックスで、呼び出す API 操作を検索します。選択した API 操作の構成ペインで、[パラメーター] タブをクリックし、API リファレンスに基づいてパラメーターを構成します。指定したパラメーターを持つ CLI コマンドが、右側ペインの [CLI の例] タブに表示されます。

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

例

次のサンプルコードでは、Alibaba Cloud CLI を使用して Elastic Compute Service の CreateInstance 操作を呼び出し、従量課金制の ECS インスタンスを作成します。 Alibaba Cloud CLI コマンドの詳細については、このトピックの「コマンドの生成」セクションをご参照ください。

コマンドを実行します。

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

結果を生成します。

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceId": "i-bp67acfmxazb4p****",
  "OrderId": "1234567890",
  "TradePrice": 0.165
}

API 操作、SDK、または Elastic Compute Service コンソールを使用して、ECS インスタンスが作成されたかどうかを確認します。