コマンドラインツール共通オプション
コマンドラインツールの共通オプションを以下に示します。
| オプション | 短縮 | 指定する値、用途 | 必須 |
|---|---|---|---|
| --access-key-id VALUE | -I | AccessKeyの文字列を指定します。 環境変数 NIFTY_ACCESS_KEY_IDより優先的に使用されます。 |
○ |
| --secret-key VALUE | -S | SecretAccessKeyの文字列を指定します。 環境変数 NIFTY_SECRET_KEYより優先的に使用されます。 |
○ |
| --url URL | -U | ニフクラAPIのサーバーのURLを指定します。 指定しない場合は環境変数 NIFTY_CLOUD_URLに設定されている値が使用されます。 |
|
| --request-method | -q | HTTPリクエストメソッドを指定します。 文字列"GET"または"POST"のいずれかを指定します。 |
|
| --connection-timeout TIMEOUT | 接続タイムアウトの時間を指定します。 単位は秒です。 |
||
| --request-timeout TIMEOUT | リクエストタイムアウトの時間を指定します。 単位は秒です。 |
||
| --delimiter VALUE | 出力で使用される区切り文字を指定します。 | ||
| --headers | 出力形式が 表形式 または 区切り文字による区切り形式 の場合、カラムヘッダーを出力します。 XML形式で出力する場合、HTTPヘッダーを出力します。 |
||
| --show-empty-fields | 空要素を出力に含めます。 | ||
| --show-request | リクエストURLを出力します。 | ||
| --show-table, --show-long, --show-xml, --quiet |
結果の出力形式を指定します。 指定しない場合、表形式で出力します。 --show-table : 表形式で出力します。 --show-long : 区切り文字で区切って出力します（一部APIのみで指定可能） -show-xml : レスポンスXMLを出力します。 --quiet : 出力しない |
||
| --verbose | -v | 詳細情報を出力します。 | |
| -?, --help | ヘルプを出力します。 | ||
| --debug | デバッグ情報を出力します。 |
出力要素
オプションなし
空要素の出力を抑止し、表形式で出力します。
INSTANCE server01 stopped pending
--show-empty-fields
空要素を文字列“(nil)“として出力します。
INSTANCE server01 stopped pending (nil)
--delimiter
指定された文字を区切り文字として出力します。
INSTANCE#server01#stopped#pending#
-- headers
ヘッダー行を出力します。
INSTANCE INSTANCE-NAME PREVIOUS-STATE CURRENT-STATE
INSTANCE server01 stopped pending
--show-request
リクエストURLを出力します。
https://jp-east-1.computing.api.nifcloud.com/api/?Action=.....
INSTANCE server01 stopped pending
--show-table
表形式で出力します。
INSTANCE server01 stopped pending
--show-long
全要素を表形式で出力します。
LOAD_BALANCER lb 10.0.0.1 10 "interval=300,target=TCP:443,timeout=30,healthy-threshold=1,unhealthy-threshold=1" east-11 "server01,server02" "protocol=https,lb-port=443,instance-port=443,balancing-type=1" "filter-type=1,111.111.111.111,111.111.111.112,111.111.111.113" 2010-05-17T11:22:33.456Z
- ※nifty-describe-lbs でのみ指定可能です。
--show-xml
ニフクラAPIのレスポンスXMLを出力します。
<StartInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>398ce68b-ad10-49db-9971-17b9da0b352e</requestId>
<instancesSet>
<item>
……
</item>
</instancesSet>
</StartInstancesResponse>
--quiet
結果を出力しません。
-verbose
ニフクラAPIのリクエストとレスポンスの詳細情報を出力します。
Setting User-Agent to [NIFCLOUD api-tools .....]
------------------------------[ REQUEST ]-------------------------------
https://jp-east-1.computing.api.nifcloud.com/api/?Action=.....
------------------------------------------------------------------------
------------------------------[ RESPONSE ]------------------------------
<StartInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
……
</StartInstancesResponse>
------------------------------------------------------------------------
INSTANCE server01 stopped pending
-request-method
リクエストのGET/POSTを指定します（デフォルト：GET）。
