Alibaba Cloud CLI は、OpenAPI Explorer に基づいて構築された汎用コマンドラインツールです。これを使用して、ENS API オペレーションの呼び出しなど、ENS リソースの管理とメンテナンスを自動化できます。
事前準備
Alibaba Cloud CLI の基本を理解しておいてください。詳細については、「Alibaba Cloud CLI とは」をご参照ください。
Alibaba Cloud CLI のインストール
Alibaba Cloud CLI は、Windows、Linux、macOS で利用できます。ご利用のオペレーティングシステムに対応するインストールパッケージを選択してください:
また、Cloud Shell を使用して Alibaba Cloud CLI コマンドをデバッグすることもできます。詳細については、「Cloud Shell とは」をご参照ください。
Alibaba Cloud CLI の設定
Alibaba Cloud アカウント (root ユーザー) は、すべての Alibaba Cloud サービスの API を管理およびアクセスする権限を持っています。Alibaba Cloud アカウントを使用して API オペレーションを呼び出すと、セキュリティリスクが発生する可能性があります。API オペレーションの呼び出しや日常の O&M 操作には、Resource Access Management (RAM) ユーザーを作成して使用することを推奨します。
Alibaba Cloud CLI を使用する前に、認証情報とリージョン ID を設定する必要があります。Alibaba Cloud CLI はさまざまな認証情報タイプをサポートしています。詳細については、「認証情報の種類」をご参照ください。この例では、AccessKey 認証情報を使用します。
-
RAM ユーザーを作成し、RAM ユーザーに必要な権限を付与します。詳細については、「RAM ユーザーの作成」および「RAM ユーザーへの権限付与」をご参照ください。
重要この例では、RAM ユーザーに
AliyunENSFullAccessポリシーを付与する必要があります。このポリシーは、ENS インスタンスのクエリと変更に対する完全制御を許可します。必要に応じて、AliyunENSReadOnlyAccessポリシーまたはカスタムポリシーを付与することもできます。詳細については、「ENS のカスタムポリシーリファレンス」をご参照ください。 -
RAM ユーザーを作成して権限を付与した後、そのユーザー用の AccessKey ペアを作成します。認証情報の設定のために、
AccessKey IDとAccessKey Secretを記録しておきます。詳細については、「AccessKey ペアの作成」をご参照ください。 -
利用可能なリージョンの ID を取得して記録します。Alibaba Cloud CLI は、指定されたリージョン ID を使用して API 呼び出しを開始します。利用可能なリージョンについては、「エンドポイント」をご参照ください。
説明Alibaba Cloud CLI を使用する際、
--regionオプションを使用して、単一のコマンドに対してリージョンを指定できます。このオプションは、デフォルトの認証情報設定および環境変数内のリージョン設定をオーバーライドします。詳細については、「コマンドオプション」をご参照ください。 -
RAM ユーザーの AccessKey ペアを使用して、AccessKey ベースの認証情報を設定します。設定プロファイルに
AkProfileという名前を付けます。詳細については、「ID 認証情報の設定と管理」をご参照ください。
CLI コマンドの生成
-
ENS の API デバッグページにログインします。
-
API デバッグページで、左側の検索ボックスを使用して、使用する API を検索します。[パラメーター設定] セクションで、必須パラメーターを入力します。次に、[パラメーター設定] セクションの隣にある [CLI の例] タブをクリックし、コマンドの例を生成します。
-
アイコンをクリックすると、Cloud Shell にリダイレクトされます。Cloud Shell でコマンドをデバッグできます。 -
アイコンをクリックして CLI コマンドをクリップボードにコピーし、ローカルのシェルに貼り付けます。-
サンプルコマンドをシェルに貼り付けてデバッグする際は、パラメーターのフォーマットに注意してください。Alibaba Cloud CLI のパラメーターフォーマットの詳細については、「パラメーターのフォーマット」をご参照ください。
-
OpenAPI Explorer によって生成された例には、デフォルトで
--regionオプションが含まれています。コマンドをローカルで実行すると、Alibaba Cloud CLI はこのオプションを優先し、デフォルトの認証情報設定および環境変数内のリージョン設定を無視します。必要に応じて、このオプションを削除または保持できます。
-
-
API オペレーションの呼び出し
構文
Alibaba Cloud CLI は、次のコマンド構文を使用します。詳細については、「構文」をご参照ください。
aliyun <command> <subcommand> [options and parameters]
コマンドオプション
コマンドオプションを指定して、コマンドの動作を変更したり、拡張機能を有効にしたりできます。一般的なオプションは次のとおりです:
-
--profile <profileName>:--profileオプションを使用し、有効な設定名profileNameを指定すると、Alibaba Cloud CLI はデフォルトの ID 認証情報設定と環境変数を無視し、指定された設定を優先してコマンドを呼び出します。 -
--help:どのコマンドレベルでも、--helpオプションを使用してそのコマンドのヘルプを取得できます。詳細については、「ヘルプ情報の取得」をご参照ください。
詳細については、「API 呼び出しのコマンドラインオプション」をご参照ください。
呼び出し例
次の例では、ENS の RebootInstance コマンドを呼び出してインスタンスを再起動します。RebootInstance コマンドの詳細については、「RebootInstance」をご参照ください。
-
次のコマンドを実行します:
aliyun ens RebootInstance --InstanceId i-5xxx8d3x --endpoint ens.aliyuncs.com -
コマンドの出力を表示します。
{ "Code": "0", "RequestId": "845748BB-9E66-52DB-B4F5-4305601AD2CF" }
ENS の API オペレーションを呼び出した後にエラーが返された場合は、エラーコードに基づいて入力パラメーターと値が有効かどうかを確認してください。
また、応答または SDK のエラーメッセージからリクエスト ID を記録し、Alibaba Cloud OpenAPI 診断を使用して問題を診断することもできます。