createNatGatewayInstance
- Print
- PDF
createNatGatewayInstance
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Overview
It creates a NAT gateway instance.
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code Can decide the Region where the NAT gateway instance will be created. regionCode can be obtained via the getRegionList action. Default: selects the first Region of the getRegionList query results | |
| zoneCode | Yes | String | - Zone code Determines the zone in which the NAT Gateway instance will be created zoneCode can be obtained via the getZoneListaction. | |
| vpcNo | Yes | String | - VPC number Determines the VPC in which the NAT Gateway instance will be decision vpcNo can be obtained via the getVpcListaction. | |
| natGatewayName | No | String | Min : 3, Max : 30 Only lowercase English letters, numbers, and "-" are allowed, and it must start with an English letter It must end with an English letter or number. | - The name of NAT Gateway to be created Default: automatically granted by NAVER Cloud Platform |
| natGatewayDescription | No | String | Min : 0, Max : 1000 Bytes | Description of a NAT Gateway to be created |
| responseFormatType | No | String | - Format type of the response result Options : xml | json Default : xml | |
| publicIpInstanceNo | No | String | - Public IP Instance number Ignored if subnet is of PRIVATE(subnetTypeCode) type If subnet is PUBLIC, if publicIpInstanceNo is NULL, it is automatically created, and if it is NOT-NULL, it is assigned. | |
| privateIp | No | String | - Private IP Ignore if subnet is PUBLIC If the subnet is PUBLIC, it is automatically allocated if NULL, and it is created with the corresponding IP if NOT-NULL. | |
| subnetNo | No | String | - SubnetNo of NATGW type If NULL, NATGW subnet of PUBLIC type is created. If NOT-NULL, create NATGateway according to NATGW Subnet's subnetTypeCode |
Responses
Response bodies
Examples
Request examples
GET {API_URL}/vpc/v2/createNatGatewayInstance
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***04
&natGatewayName=test-***
&subnetNo=***28
&publicIpInstanceNo=***25
Response examples
<createNatGatewayInstanceResponse>
<requestId>4475d78c-4c27-4404-807d-7b0b645bb127</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>INIT</code>
<codeName>init</codeName>
</natGatewayInstanceStatus>
<natGatewayInstanceStatusName>under preparation</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>
</createNatGatewayInstanceResponse>
Was this article helpful?