Alibaba Cloud CLI は、複数の Alibaba Cloud サービスをサポートしています。このトピックでは、Alibaba Cloud CLI コマンドを使用して一般的な API 操作を呼び出す方法と、OpenAPI Explorer で CLI コマンドを生成する方法について説明します。
前提条件
一部の API 操作の呼び出しには料金が発生する場合があります。コマンドをデバッグする前に、必要な Alibaba Cloud サービスが有効化されていることを確認してください。また、これらのサービスの課金ルールと API 操作の呼び出し方法についても理解しておく必要があります。
ローカルでコマンドをデバッグする前に、Alibaba Cloud CLI をインストールし、認証情報を正しく設定しておく必要があります。 詳細については、「」、「インストールガイド」、および「認証情報を設定する」をご参照ください。
OpenAPI Explorer では、サービス名に基づいて Alibaba Cloud サービスの API リファレンスと、対応する Alibaba Cloud CLI コマンドのサンプルコードを取得できます。詳細については、このトピックの「コマンドの生成」セクションをご参照ください。
コマンドの生成
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 はデフォルトの認証情報設定および環境変数設定内のリージョン情報を無視し、指定されたリージョンを優先してコマンドを実行します。ビジネス要件に応じて、このオプションを削除または保持できます。
例
次のサンプルコードは、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 インスタンスが作成されたかどうかを確認します。