getNatGatewayInstanceList
    • PDF

    getNatGatewayInstanceList

    • PDF

    Article summary

    Available in VPC

    Summary

    It searches the list of NAT gateway instances.

    Requests

    Request parameters

    Parameter NameRequirement statusTypeRestrictionsDescription
    regionCodeNoString- Region code
    You can decide the region in which the list of NAT Gateway instance will be queried
    Region code can be obtained through the getRegionList action
    Default: selects the first region of the getRegionList search results
    zoneCodeNoString- Zone code
    You can decide the zone in which the list of NAT Gateway instance will be queried
    Zone code can be obtained through the getZoneList action
    natGatewayInstanceNoList.NNoList<String>- List of the NAT Gateway instance numbers
    You can search by filtering with a NAT Gateway instance number
    Net Gateway instance No. can be obtained through the getNatGatewayInstanceList action
    ex) --natGatewayInstanceNoList 1234 2345
    publicIpNoString- Public IP Address
    You can search by filtering with a public IP address assigned to NAT Gateway
    vpcNameNoString- VPC name
    You can search by filtering with a VPC name
    natGatewayNameNoString- NAT Gateway name
    You can search by filtering with a NAT Gateway name
    natGatewayInstanceStatusCodeNoString- Status code of the NAT Gateway instance
    You can search by filtering with the status code of the NAT Gateway instance
    Options: INIT
    pageNoNoInteger- Page number of the paged results
    The results can be paged using page No. and page size
    pageSizeConditionalInteger- Size of each page to be displayed when paging
    The results can be paged using page No. and page size
    Entering the information is required when page No. is entered
    responseFormatTypeNoString- Format type of the response result
    Options: xml | json
    Default: xml
    natGatewayTypeNoString- NAT Gateway type
    Options: PRVT
    subnetNameNoString- Subnet name
    subnetNoNoString- Subnet number
    privateIpNoString- Private IP address
    publicIpInstanceNoNoString- Public IP Instance No.

    Response

    Response data type

    • NatGateway instance list type
    NatGatewayInstanceList extends CommonResponse
    private Integer totalRows;
    private List natGatewayInstanceList = new ArrayList<>();
    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;

    Examples

    Request examples

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

    Response examples

    <getNatGatewayInstanceListResponse>
      <requestId>7d68eb6c-6015-45d1-8711-e5e65d3704c6</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <natGatewayInstanceList>
        <natGatewayInstance>
          <vpcNo>***36</vpcNo>
          <vpcName>test-vpc</vpcName>
          <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
          <natGatewayName>test-***</natGatewayName>
          <publicIp>***.***.109.101</publicIp>
          <natGatewayInstanceStatus>
            <code>RUN</code>
            <codeName>run</codeName>
          </natGatewayInstanceStatus>
          <natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
          <natGatewayInstanceOperation>
             <code>NULL</code>
             <codeName>NULL OP</codeName>
          </natGatewayInstanceOperation>
          <createDate>2023-04-18T15:13:27+0900</createDate>
          <natGatewayDescription></natGatewayDescription>
          <zoneCode>KR-1</zoneCode>
          <natGatewayType>
             <code>PBLIP</code>
             <codeName>Public</codeName>
          </natGatewayType>
          <subnetName>v-kr1-pub-natgw-***</subnetName>
          <subnetNo>***28</subnetNo>
          <privateIp>10.0.***.***</privateIp>
          <publicIpInstanceNo>***25</publicIpInstanceNo>
        </natGatewayInstance>
      </natGatewayInstanceList>
    </getNatGatewayInstanceListResponse>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.