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|KRS>] \
    [--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": "vpc01",
        "natGatewayInstanceNo": "56789012",
        "natGatewayName": "test-natgw-01",
        "publicIp": "192.0.2.10",
        "natGatewayInstanceStatus": {
          "code": "RUN",
          "codeName": "RUN 상태"
        },
        "natGatewayInstanceStatusName": "Running",
        "natGatewayInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        },
        "createDate": "2026-07-20T10:14:18+0900",
        "natGatewayDescription": "Test NAT Gateway",
        "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": "cbb47f47-c0da-4081-8cea-683f5821c289",
    "returnCode": "0",
    "returnMessage": "success"
  }
}