getSubnetList

VPC環境で利用できます。

ユーザーが指定した条件に基づいて Subnetリストを照会します。

構文

getSubnetList構文は次の通りです。

./ncloud vpc getSubnetList \
    [--vpcNo <vpc-no>] \
    [--zoneCode <zone-code>] \
    [--subnetNoList <subnet-no-list>] \
    [--subnetName <subnet-name>] \
    [--subnet <subnet-ip-range>] \
    [--subnetTypeCode <PUBLIC|PRIVATE>] \
    [--usageTypeCode <GEN|LOADB|BM|NATGW>] \
    [--networkAclNo <network-acl-no>] \
    [--subnetStatusCode <INIT|CREATING|RUN|TERMTING>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

getSubnetListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページング時に表示する各ページのサイズ `pageNo`入力時、必ず入力 `pageNo`、`pageSize`を利用して結果値をページング処理

任意オプション

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

オプション	タイプ	必須の有無	説明
`--vpcNo`	String	Optional	VPC番号 getVpcListを参照
`--zoneCode`	String	Optional	ゾーンコード getZoneListを参照
`--subnetNoList`	List	Optional	Subnet番号リストスペースで区切って複数入力可能 (例: `--subnetNoList 1234 2345`)
`--subnetName`	String	Optional	Subnet名
`--subnet`	String	Optional	IPアドレスの範囲
`--subnetTypeCode`	String	Optional	Subnetタイプコード `PUBLIC` \| `PRIVATE`
`--usageTypeCode`	String	Optional	Subnetの用途タイプコード `GEN` \| `LOADB` \| `BM` \| `NATGW` `GEN`: 一般 `LOADB`: ロードバランサ専用 `BM`: ベアメタル専用 `NATGW`: NAT Gateway専用
`--networkAclNo`	String	Optional	Network ACL番号 getNetworkAclListを参照
`--subnetStatusCode`	String	Optional	Subnetの状態コード `INIT` \| `CREATING` \| `RUN` \| `TERMTING`
`--pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用して結果値をページング処理

共通オプション

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

例

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

コマンド

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

./ncloud vpc getSubnetList \
    --vpcNo 12345678 \
    --zoneCode KR-1 \
    --subnetNoList 23456789 23456790 \
    --subnetName test-subnet-01 \
    --subnet 10.0.1.0/24 \
    --subnetTypeCode PUBLIC \
    --usageTypeCode GEN \
    --networkAclNo 34567890 \
    --subnetStatusCode RUN \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

出力

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

{
  "getSubnetListResponse": {
    "totalRows": 1,
    "subnetList": [
      {
        "subnetNo": "23456789",
        "vpcNo": "12345678",
        "zoneCode": "KR-1",
        "subnetName": "test-subnet-01",
        "subnet": "10.0.1.0/24",
        "subnetStatus": {
          "code": "RUN",
          "codeName": "実行中"
        },
        "createDate": "2026-07-07T14:12:27+0900",
        "subnetType": {
          "code": "PUBLIC",
          "codeName": "Public"
        },
        "usageType": {
          "code": "GEN",
          "codeName": "General"
        },
        "networkAclNo": "34567890"
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}