getNatGatewayInstanceDetail
    • PDF

    getNatGatewayInstanceDetail

    • PDF

    Article summary

    Can be used in a VPC environment.

    Overview

    Query the NAT Gateway instance details using the NAT Gateway instance number.

    Request

    Request parameter

    Parameter NameRequired StatusTypeRestrictionsDescription
    regionCodeNoStringRegion Code
    You can decide the region where the NAT Gateway instance details will be queried.
    The regionCode can be obtained through the getRegionList action.
    Default: Select the first region of the getRegionList query results.
    natGatewayInstanceNoYesStringThe number of the NAT Gateway instance to be queried
    The natGatewayInstanceNo can be obtained through the getNatGatewayInstanceList action.
    responseFormatTypeNoStringFormat type for the response result
    Options : xml | json
    Default : xml

    Response

    Response data type

    • NatGatewayInstanceList 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;

    Example

    Request example

    ncloud vpc getNatGatewayInstanceDetail --regionCode KR --natGatewayInstanceNo ***9734
    

    Response example

    <getNatGatewayInstanceDetailResponse>
      <requestId>f692e1b8-b15b-4c39-8911-150263abf71b</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <natGatewayInstanceList>
        <natGatewayInstance>
          <vpcNo>***04</vpcNo>
          <vpcName>test-***</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>2020-08-06T11:47:40+0900</createDate>
          <natGatewayDescription></natGatewayDescription>
          <zoneCode>KR-1</zoneCode>
        </natGatewayInstance>
      </natGatewayInstanceList>
    </getNatGatewayInstanceDetailResponse>
    

    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.