---
title: "setNatGatewayDescription"
slug: "networking-vpc-natgateway-setnatgatewaydescription"
updated: 2026-09-17T09:58:20Z
published: 2026-09-17T09:58:20Z
canonical: "api.ncloud-docs.com/networking-vpc-natgateway-setnatgatewaydescription"
---

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

# setNatGatewayDescription

VPC環境で利用できます。

NAT Gatewayインスタンスの番号を指定して NAT Gatewayインスタンスの説明を変更します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET \| POST | /vpc/v2/setNatGatewayDescription |

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

### リクエストヘッダ

VPC APIで共通して使用されるヘッダの詳細は、[VPCのリクエストヘッダ](/docs/ja/networking-vpc#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 説明変更対象 NAT Gatewayインスタンスのリージョンコード - 照会結果の最初のリージョン(デフォルト) - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 |
| `natGatewayInstanceNo` | String | Required | 説明変更対象の NAT Gatewayインスタンス番号 - [getNatGatewayInstanceList](/docs/ja/networking-vpc-natgateway-getnatgatewayinstancelist)を参照 |
| `natGatewayDescription` | String | Optional | 変更後の NAT Gatewayの説明 (Byte) - 0~1000 |
| `output` | String | Optional | レスポンス結果の形式 - `xml` \| `json`(デフォルト) |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/setNatGatewayDescription
?regionCode=KR
&natGatewayInstanceNo=***38
&natGatewayDescription=test-description' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの詳細は、[NatGatewayInstanceList](/docs/ja/common-vapidatatype-natgatewayinstancelist)をご参照ください。

### レスポンスステータスコード

VPC APIで共通して使用されるレスポンスステータスコードの詳細は、[VPCのレスポンスステータスコード](/docs/ja/networking-vpc#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
<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>
```