Available in VPC
Overview
Edit the description of a NAT Gateway.
Request
Request parameters
Parameter name |
Required |
Type |
Restrictions |
Description |
regionCode |
No |
String |
|
Region code- Determine the Region of the NAT Gateway instance for which you want to edit the description.
- regionCode can be obtained through the getRegionList action.
- Default: Select the first Region of the getRegionList query result.
|
natGatewayInstanceNo |
Yes |
String |
|
NAT Gateway instance number whose description you want to edit |
natGatewayDescription |
No |
String |
Min: 0, Max: 1000 Bytes |
Description of the NAT Gateway to be edited |
responseFormatType |
No |
String |
|
Response result's format type- Options: xml | json
- Default: xml
|
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 setNatGatewayDescription --regionCode KR --natGatewayInstanceNo ***38 --natGatewayDescription test-description
Response example
<setNatGatewayDescriptionResponse>
<requestId>664d591b-3089-4df8-b962-ef00a5171165</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>test-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>
</setNatGatewayDescriptionResponse>