getNatGatewayInstanceList

VPC環境で利用できます。

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

構文

getNatGatewayInstanceList構文は次の通りです。

./ncloud vpc getNatGatewayInstanceList \
    [--zoneCode <zone-code>] \
    [--natGatewayInstanceNoList <nat-gateway-instance-no-list>] \
    [--natGatewayName <nat-gateway-name>] \
    [--natGatewayInstanceStatusCode <INIT|RUN|SET|TERMTING>] \
    [--natGatewayTypeCode <PRVT|PBLIP>] \
    [--vpcName <vpc-name>] \
    [--subnetName <subnet-name>] \
    [--subnetNo <subnet-no>] \
    [--publicIp <public-ip>] \
    [--privateIp <private-ip>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

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

任意オプション

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

オプション	タイプ	必須の有無	説明
`--zoneCode`	String	Optional	ゾーンコード getZoneListを参照
`--natGatewayInstanceNoList`	List	Optional	NAT Gatewayインスタンス番号リストスペースで区切って複数入力可能 (例: `--natGatewayInstanceNoList 1234 2345`)
`--natGatewayName`	String	Optional	NAT Gateway名
`--natGatewayInstanceStatusCode`	String	Optional	NAT Gatewayインスタンスの状態コード `INIT` \| `RUN` \| `SET` \| `TERMTING`
`--natGatewayTypeCode`	String	Optional	NAT Gatewayタイプ `PRVT` \| `PBLIP` `PRVT`: Private NAT Gateway `PBLIP`: Public NAT Gateway
`--vpcName`	String	Optional	VPC名
`--subnetName`	String	Optional	Subnet名
`--subnetNo`	String	Optional	Subnet番号
`--publicIp`	String	Optional	パブリック IPアドレス
`--privateIp`	String	Optional	プライベート IPアドレス
`--pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用して結果値をページング処理

共通オプション

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

例

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

コマンド

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

./ncloud vpc getNatGatewayInstanceList \
    --zoneCode KR-1 \
    --natGatewayInstanceNoList 56789012 56789013 \
    --natGatewayName test-natgw-01 \
    --natGatewayInstanceStatusCode RUN \
    --natGatewayTypeCode PBLIP \
    --vpcName test-vpc-01 \
    --subnetName test-natgw-subnet \
    --subnetNo 23456789 \
    --publicIp 192.0.2.10 \
    --privateIp 10.0.3.6 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

出力

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

{
  "getNatGatewayInstanceListResponse": {
    "totalRows": 1,
    "natGatewayInstanceList": [
      {
        "vpcNo": "12345678",
        "vpcName": "test-vpc-01",
        "natGatewayInstanceNo": "56789012",
        "natGatewayName": "test-natgw-01",
        "publicIp": "192.0.2.10",
        "natGatewayInstanceStatus": {
          "code": "RUN",
          "codeName": "実行中"
        },
        "natGatewayInstanceStatusName": "Running",
        "natGatewayInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        },
        "createDate": "2026-07-07T14:48:38+0900",
        "natGatewayDescription": "Updated NAT Gateway description",
        "zoneCode": "KR-1",
        "natGatewayType": {
          "code": "PBLIP",
          "codeName": "パブリック"
        },
        "subnetName": "test-natgw-subnet",
        "subnetNo": "23456789",
        "privateIp": "10.0.3.6",
        "publicIpInstanceNo": "78901234",
        "natGatewayIpList": [
          {
            "type": "PRIMARY",
            "privateIp": "10.0.3.6",
            "publicIp": "192.0.2.10",
            "publicIpInstanceNo": "78901234"
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}