getNatGatewayInstanceList

Prev Next

Available in VPC

Overview

Get a list of NAT Gateway instances.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String Region code
  • Determine the Region in which the NAT Gateway instance list will be queried.
  • regionCode can be obtained through the getRegionList action.
  • Default: Select the first Region of the getRegionList query result.
zoneCode No String Zone code
  • Determine the zone where the NAT Gateway instance list will be queried.
  • zoneCode can be obtained through the getZoneList action.
natGatewayInstanceNoList.N No List<String> NAT Gateway instance number list
  • Search by filtering with the NAT Gateway instance number.
  • natGatewayInstanceNo can be obtained through the getNatGatewayInstanceList action.
  • Example) --natGatewayInstanceNoList 1234 2345
publicIp No String Public IP address
  • Search by filtering with the public IP address assigned to the NAT Gateway.
vpcName No String VPC name
  • Search by filtering with the VPC name.
natGatewayName No String NAT Gateway name
  • Search by filtering with the NAT Gateway name.
natGatewayInstanceStatusCode No String NAT Gateway instance status code
  • Search by filtering with the NAT Gateway instance status code.
  • Options: INIT | RUN | SET | TERMTING
pageNo No Integer Page numbers in paged results
  • The results can be paged using pageNo and pageSize.
pageSize Conditional Integer Size of each page to display when paging
  • The results can be paged using pageNo and pageSize.
  • Required when entering pageNo
output No String Response result's format type
  • Options: xml | json
  • Default: json
natGatewayTypeCode No String NAT Gateway type
  • Options: PRVT | PBLIP
subnetName No String Subnet name
subnetNo No String Subnet number
privateIp No String Private IP address
publicIpInstanceNo No String Public IP instance number

Response

Response data type

NatGatewayInstanceList extends CommonResponse
private Integer totalRows;
private List<NatGatewayInstance> natGatewayInstanceList
NatGatewayInstance
private String vpcNo;
private String vpcName;
private String natGatewayInstanceNo;
private String natGatewayName;
private String publicIp;
private CommonCode natGatewayInstanceStatus;
private String natGatewayInstanceStatusName;
private CommonCode natGatewayInstanceOperation;
private Date createDate;
private String natGatewayDescription;
private String zoneCode;
private CommonCode natGatewayType;
private String subnetName;
private String subnetNo;
private String privateIp;
private String publicIpInstanceNo;
private List<NatGatewayIp> natGatewayIpList;
NatGatewayIp
private String type;
private String privateIp;
private String publicIp;
private String publicIpInstanceNo;

Examples

Request example

ncloud vpc getNatGatewayInstanceList --regionCode KR --zoneCode KR-1 --natGatewayInstanceNoList ***9734 --publicIp ***.***.109.101 --vpcName test-vpc --natGatewayName test-*** --natGatewayInstanceStatusCode RUN  --natGatewayTypeCode PBLIP

Response example

<getNatGatewayInstanceListResponse>
  <requestId>09b86d75-4a0b-4148-ab7f-5412d15bcb22</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***36</vpcNo>
      <vpcName>normal-***</vpcName>
      <natGatewayInstanceNo>*****9288</natGatewayInstanceNo>
      <natGatewayName>public-***</natGatewayName>
      <publicIp>***.***.153.178</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>RUN status</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2025-04-25T14:19:32+0900</createDate>
      <natGatewayDescription>description</natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
      <natGatewayType>
        <code>PBLIP</code>
        <codeName>Public</codeName>
      </natGatewayType>
      <subnetName>public-***</subnetName>
      <subnetNo>***29</subnetNo>
      <privateIp>10.0.1.6</privateIp>
      <publicIpInstanceNo>****290</publicIpInstanceNo>
      <natGatewayIpList>
        <natGatewayIp>
          <type>PRIMARY</type>
          <privateIp>10.0.1.6</privateIp>
          <publicIp>***.***.153.178</publicIp>
          <publicIpInstanceNo>****290</publicIpInstanceNo>
        </natGatewayIp>
        <natGatewayIp>
          <type>SECONDARY</type>
          <privateIp>10.0.1.7</privateIp>
          <publicIp>***.***.109.24</publicIp>
          <publicIpInstanceNo>****805</publicIpInstanceNo>
        </natGatewayIp>
      </natGatewayIpList>
    </natGatewayInstance>
  </natGatewayInstanceList>
</getNatGatewayInstanceListResponse>