---
title: "setNatGatewayDescription"
slug: "cli-vpc-natgateway-setnatgatewaydescription"
tags: ["NAT Gateway", "VPC"]
updated: 2026-05-21T09:02:07Z
published: 2026-05-21T09:11:37Z
canonical: "cli-gov.ncloud-docs.com/cli-vpc-natgateway-setnatgatewaydescription"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://cli-gov.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# setNatGatewayDescription

<p class="platform-info type-vpc">VPC 환경에서 이용 가능합니다.</p>

## 개요<a name="개요"></a>

NAT Gateway 설명을 수정합니다.

## 요청<a name="요청"></a>

### 요청 파라미터<a name="요청파라미터"></a>


| 파라미터명                            | 필수 여부      | 타입            | 제약 사항               | 설명                                         |
| ---------------------------------- | ------------ | -------------- | --------------------- | ------------------------------------------- |
| regionCode                         | No           | String         |                       | - 리전 코드<br/>설명을 수정할 NAT Gateway 인스턴스의 리전(Region) 결정 가능<br/>regionCode는 [getRegionList](/docs/cli-vserver-server-common-getregionlist) 액션을 통해 획득 가능<br/>Default : getRegionList 조회 결과의 첫 번째 리전을 선택  |
| natGatewayInstanceNo               | Yes          | String         |                       | - 설명을 수정할 NAT Gateway 인스턴스 번호<br/>natGatewayInstanceNo는 [getNatGatewayInstanceList](/docs/cli-vpc-natgateway-getnatgatewayinstancelist) 액션을 통해 획득 가능   |
| natGatewayDescription              | No           | String         | Min : 0, Max : 1000 Bytes    | 수정할 NAT Gateway에 대한 설명    |
| responseFormatType                 | No           | String         |                       | - 응답 결과의 포맷 타입<br/>Options : xml \| json<br/>Default : xml |

## 응답<a name="응답"></a>

### 응답 데이터 타입<a name="응답데이터타입"></a>

- NatGatewayInstanceList 타입

| 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 List\<NatGatewayIp\> natGatewayIpList; | 

| NatGatewayIp |
| ---------- |
|private String type; |
|private String privateIp; |
|private String publicIp; |
|private String publicIpInstanceNo; |


## 예시<a name="예시"></a>

### 요청 예시<a name="요청예시"></a>

```
ncloud vpc setNatGatewayDescription --regionCode KR --natGatewayInstanceNo ***38 --natGatewayDescription test-description
```

### 응답 예시<a name="응답예시"></a>

```xml
<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 상태</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>공인</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>
```