setNatGatewayDescription
- Print
- PDF
setNatGatewayDescription
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Overview
Modify the NAT Gateway description.
Request
Request parameter
| Parameter Name | Required Status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region Code You can decide the region of the NAT Gateway instance whose description will be modified. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results. | |
| natGatewayInstanceNo | Yes | String | The number of the NAT Gateway instance whose description will be modified The natGatewayInstanceNo can be obtained through the getNatGatewayInstanceList action. | |
| natGatewayDescription | No | String | Min : 0, Max : 1000 Bytes | The NAT Gateway description to be modified |
| responseFormatType | No | String | Format type for the response result Options : xml | json Default : xml |
Response
Response data type
- NatGatewayInstanceList type
| NatGatewayInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| 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 setNatGatewayDescription --regionCode KR --natGatewayInstanceNo ***38 --natGatewayDescription test-description
Response example
<setNatGatewayDescriptionResponse>
<requestId>bbe69135-359f-443a-8a32-d38d590e2c87</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-06-24T08:58:20+0900</createDate>
<natGatewayDescription>test-description</natGatewayDescription>
<zoneCode>KR-1</zoneCode>
</natGatewayInstance>
</natGatewayInstanceList>
</setNatGatewayDescriptionResponse>
Was this article helpful?