Classic/VPC環境で利用できます。
Ncloud CLIのコマンド構造、オプション指定、出力形式などについて説明します。
コマンドヘルプ
コマンドの末尾にhelpを追加すると、利用可能なコマンドとオプションを確認できます。
最上位コマンドリストを確認するには、次のように実行します。
./ncloud help
上位コマンドのサブコマンドを確認するには、次のように実行します。
./ncloud vserver help
./ncloud vloadbalancer help
コマンドの構造
Ncloud CLIはコマンドラインでマルチパート構造を使用します。この構造は Ncloudに対する基本呼び出しで始まり、コマンドごとに実行する作業に対するサブコマンドがあります。CLIでオプションをどんな順番で指定しても構いません。
./ncloud <command> <subcommand> [options]
オプションの指定
オプションに渡す値は、ほとんどが文字列か数字です。その他、Listや Map形式の値を渡すことができます。
List形式
List形式の値は、スペース「 」、コンマ「,」、またはオプションを繰り返し指定して渡すことができます。
./ncloud server getPublicIpInstanceList --publicIpInstanceNoList 573361 571968
./ncloud server getPublicIpInstanceList --publicIpInstanceNoList 573361,571968
./ncloud server getPublicIpInstanceList --publicIpInstanceNoList 573361 --publicIpInstanceNoList 571968
Map形式
スペースがない文字列は、引用符で囲んでも囲まなくても構いません。ただし、Map形式の文字列は引用符で囲む必要があります。次の例のように、Linux、macOS、Unixおよび Windows PowerShellでは単一引用符「'」または二重引用符「"」が使用可能で、Windowsコマンドプロンプトでは二重引用符「''」を使用します。
-
Windows PowerShell, Linux, MacOS, Unix
./ncloud loadbalancer createLoadBalancerInstance --loadBalancerName penguin --loadBalancerRuleList 'protocolTypeCode="HTTP",loadBalancerPort="80",serverPort="80",l7HealthCheckPath="/l7check.html",proxyProtocolUseYn="N"' -
Windowsコマンドプロンプト
ncloud loadbalancer createLoadBalancerInstance --loadBalancerName penguin --loadBalancerRuleList "protocolTypeCode='HTTP',loadBalancerPort='80',serverPort='80',l7HealthCheckPath='/l7check.html',proxyProtocolUseYn='N'"
Timeoutの設定
Read Timeoutと Connect Timeoutの時間を設定できます。秒単位で設定でき、デフォルト値は300秒です。
./ncloud server getZoneList --read-timeout 10
./ncloud server getZoneList --connect-timeout 5
出力形式
Ncloud CLIは二つの出力形式をサポートします。--outputオプションがなければ、基本JSON形式で出力されます。XMLで出力するには、次のように実行してください。
./ncloud server getZoneList --output xml