createNatGatewayInstance

Available in VPC

Overview

Create a NAT Gateway instance.

Request

Request parameters

Parameter name	Required	Type	Restrictions	Description
regionCode	No	String		Region code Determine the Region in which the NAT Gateway instance will be created. regionCode can be obtained through the getRegionList action. Default: Select the first Region of the getRegionList query result.
zoneCode	Yes	String		Zone code Determine the zone where the NAT Gateway instance list will be created. zoneCode can be obtained through the getZoneList action.
vpcNo	Yes	String		VPC number Determine the VPC in which the NAT Gateway instance will be created. vpcNo can be obtained through the getVpcList action.
natGatewayName	No	String	Min: 3, Max: 30 Only English letters, numbers, and special character "-" are allowed, and it must start with an English letter. It must end with an English letter or number.	Name of the NAT Gateway to create Default: NAVER Cloud Platform automatically assigns it.
natGatewayDescription	No	String	Min: 0, Max: 1000 Bytes	Description of the NAT Gateway to be created
responseFormatType	No	String		Response result's format type Options: xml \| json Default: xml
publicIpInstanceNo	No	String		Public IP instance number Ignore if the subnet is PRIVATE (subnetTypeCode) type. If the subnet is PUBLIC, publicIpInstanceNo is automatically created if NULL, and assigned if NOT-NULL.
privateIp	No	String		Private IP Ignore if the subnet is PUBLIC. If Subnet is PUBLIC, it is automatically assigned if NULL, and created with the corresponding IP if NOT-NULL.
subnetNo	No	String		NATGW type's SubnetNo If NULL, create a NATGW subnet of PUBLIC type. If NOT-NULL, create NATGateway according to the subnetTypeCode of NATGW subnet.

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 createNatGatewayInstance --regionCode KR --zoneCode KR-1 --vpcNo ***04 --natGatewayName test-*** --subnetNo ***28 --publicIpInstanceNo ***25

Response example

<createNatGatewayInstanceResponse>
  <requestId>fae73c15-7b8d-4c09-80c2-21d46a327c4d</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></publicIp>
      <natGatewayInstanceStatus>
        <code>INIT</code>
        <codeName>INIT status</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Creating</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>CREAT</code>
        <codeName>CREAT OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2025-05-08T18:38:25+0900</createDate>
      <natGatewayDescription></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></publicIpInstanceNo>
      <natGatewayIpList>
        <natGatewayIp>
          <type>PRIMARY</type>
          <privateIp>10.0.1.8</privateIp>
          <publicIp></publicIp>
          <publicIpInstanceNo></publicIpInstanceNo>
        </natGatewayIp>
      </natGatewayIpList>
    </natGatewayInstance>
  </natGatewayInstanceList>
</createNatGatewayInstanceResponse>