Alibaba Cloud CLI:Alibaba Cloud CLI のコマンドラインオプション

オプション

説明

--profile,-p

--profile または -p オプションを使用して、構成プロファイルを指定できます。 有効な構成プロファイルを指定すると、Alibaba Cloud CLI はデフォルトの ID クレデンシャルと環境変数の構成を無視し、指定した構成を使用してコマンドを実行します。

例: DescribeInstances 構成プロファイル akProfile を使用して、Elastic Compute Service ( ECS ) の DescribeInstances 操作を呼び出します。

aliyun ecs DescribeInstances --profile akProfile

--region

--region オプションを使用して、リージョンを指定できます。有効なリージョンを指定すると、Alibaba Cloud CLI はデフォルトの ID クレデンシャルおよび環境変数の構成のリージョンを無視し、指定したリージョンを使用してコマンドを実行します。

例: cn-beijing リージョンを使用して、ECS の DescribeInstances 操作を呼び出します。

aliyun ecs DescribeInstances --region cn-beijing

--endpoint

--endpoint オプションを使用して、エンドポイントを指定できます。 Alibaba Cloud サービスでサポートされているエンドポイントについては、サービスのドキュメントの[エンドポイント] トピック（[開発者リファレンス] > [API リファレンス] セクション内）を参照してください。

例: metrics.cn-qingdao.aliyuncs.com エンドポイントを使用して、CloudMonitor の DescribeMonitorGroups 操作を呼び出します。

aliyun cms DescribeMonitorGroups --endpoint metrics.cn-qingdao.aliyuncs.com

--version

--version オプションを使用して、API バージョンを指定できます。 このオプションは、--force オプションと一緒に使用する必要があります。 詳細については、「API 操作を強制的に呼び出す」をご参照ください。

例: 2017-03-01 API バージョンを使用して、CloudMonitor の DescribeMetricList 操作を呼び出します。

aliyun cms QueryMetricList \
  --Project acs_ecs_dashboard \
  --Metric cpu_idle \
  --version 2017-03-01 \
  --force

--header

--header オプションを使用して、リクエストヘッダーを追加できます。 このオプションを繰り返し使用して、複数のリクエストヘッダーを追加できます。

例: X-foo=bar リクエストヘッダーをコマンドに追加します。

aliyun <product> <ApiName> --header X-foo=bar

--body

--body オプションを使用して、リソース指向アーキテクチャ ( ROA ) API 操作を呼び出すときに、文字列をリクエストボディとして追加できます。

例: RunClusterCheck 操作を、リクエスト本文として指定された JSON 文字列を使用して、Container Service for Kubernetes (ACK) で呼び出します。

aliyun cs POST /clusters/{cluster_id}/checks --body "{\"type\":\"NodePoolUpgrade\",\"target\":\"np1f6779297c4444a3a1cdd29be8e5****\"}"

--body-file

--body-file オプションを使用して、リモートプロシージャコール ( RPC ) API 操作を呼び出すときに、ファイルをリクエストボディとして追加できます。 このオプションは、--body オプションよりも優先されます。

例: ファイルをリクエスト本文として使用して、Container Service for Kubernetes (ACK) の RunClusterCheck 操作を呼び出します。

aliyun cs POST /clusters/{cluster_id}/checks --body-file /usr/local/bin/example.json

{
    "type": "NodePoolUpgrade", // タイプ
    "target": "np1f6779297c4444a3a1cdd29be8e5****" // ターゲット
}

--read-timeout

--read-timeout オプションを使用して、I/O タイムアウト期間を秒単位で指定できます。 有効な I/O タイムアウト期間を指定すると、Alibaba Cloud CLI はデフォルトの ID クレデンシャル構成の I/O タイムアウト期間を無視し、指定した I/O タイムアウト期間を使用してコマンドを実行します。

例: I/O タイムアウト期間を 20 秒に指定します。

aliyun <product> <ApiName> --read-timeout 20

--connect-timeout

--connect-timeout オプションを使用して、接続タイムアウト期間を秒単位で指定できます。有効な接続タイムアウト期間を指定すると、Alibaba Cloud CLI はデフォルトの ID クレデンシャル構成の接続タイムアウト期間を無視し、指定した接続タイムアウト期間を使用してコマンドを実行します。

例: 接続タイムアウト期間を 20 秒に指定します。

aliyun <product> <ApiName> --connect-timeout 20

--retry-count

--retry-count オプションを使用して、許可される再試行回数を指定できます。 有効な数値を指定すると、Alibaba Cloud CLI はデフォルトの ID クレデンシャル構成の関連する再試行構成を無視し、指定した再試行回数を使用してコマンドを実行します。

例: 許可される再試行回数を 5 に指定します。

aliyun <product> <ApiName> --retry-count 5

--secure

--secure オプションを使用して、HTTPS モードを有効にできます。 ただし、API 操作が HTTPS をサポートしていない場合、リクエストは失敗します。

--insecure

--insecure オプションを使用して、HTTP モードを有効にできます。 ただし、API 操作が HTTP をサポートしていない場合、リクエストは失敗します。

--quiet,-q

--quiet オプションを使用して、戻り値の出力を無効にできます。

--help

--help オプションを使用して、コマンドに関するヘルプ情報を取得できます。

詳細については、「help コマンドを使用する」をご参照ください。

--output,-o

--output オプションを使用して、テーブル形式で返すフィールドを指定できます。

詳細については、「パラメーターを抽出して出力を表にする」をご参照ください。

--pager

--pager オプションを使用して、ページング API 操作の集計結果を返すように指定できます。

詳細については、「ページング操作の結果を集計する」をご参照ください。

--force

--force オプションを使用して、API 操作を強制的に呼び出し、メタデータリストにないパラメーターを使用するように指定できます。

詳細については、「API 操作を強制的に呼び出す」をご参照ください。

--waiter

--waiter オプションを使用して、戻り値をポーリングし、フィールドが特定の値に変更されたときにデータを返すように指定できます。

詳細については、「戻り値をポーリングする」をご参照ください。

--dryrun

--dryrun オプションを使用して、サーバーへの呼び出しをシミュレートし、クラウドリソースで実際の操作を実行せずにシミュレーション結果を返すように指定できます。

詳細については、「呼び出しをシミュレートする」をご参照ください。