getVpcList

VPC環境で利用できます。

ユーザーが指定した条件に基づいて VPCリストを検索します。

構文

getVpcList構文は次の通りです。

./ncloud vpc getVpcList \
    [--vpcStatusCode <INIT|CREATING|RUN|TERMTING>] \
    [--vpcName <vpc-name>] \
    [--vpcNoList <vpc-no-list>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

getVpcListの実行時に指定できるオプションについて説明します。

任意オプション

getVpcListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--vpcStatusCode`	String	Optional	VPCの状態コード `INIT` \| `CREATING` \| `RUN` \| `TERMTING`
`--vpcName`	String	Optional	VPC名
`--vpcNoList`	List	Optional	VPC番号スペースで区切って複数入力可能 (例: `--vpcNoList 1234 2345`)

共通オプション

vpcコマンドで共通して使用するオプションについては、VPCのオプションをご参照ください。

例

VPCリストの照会リクエストが成功すると、各 VPCの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vpc getVpcList \
    --vpcStatusCode RUN \
    --vpcNoList 12345678 23456789 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "getVpcListResponse": {
    "totalRows": 1,
    "vpcList": [
      {
        "vpcNo": "12345678",
        "vpcName": "test-vpc-01",
        "ipv4CidrBlock": "10.0.0.0/16",
        "vpcStatus": {
          "code": "RUN",
          "codeName": "実行中"
        },
        "regionCode": "KR",
        "vpcType": "NORMAL",
        "createDate": "2026-07-07T14:07:27+0900"
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}