setNatGatewayDescription

Available in VPC

Edit the NAT Gateway instance description by specifying the NAT Gateway instance number.

Syntax

The setNatGatewayDescription syntax is as follows:

./ncloud vpc setNatGatewayDescription \
    --natGatewayInstanceNo <nat-gateway-instance-no> \
    [--natGatewayDescription <nat-gateway-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running setNatGatewayDescription.

Required options

The following options are required for setNatGatewayDescription.

Options	Type	Required	Description
`--natGatewayInstanceNo`	String	Required	NAT Gateway instance number See getNatGatewayInstanceList.

Optional options

These are the optional options for setNatGatewayDescription. Options that are not specified will use their default values.

Options	Type	Required	Description
`--natGatewayDescription`	String	Optional	NAT Gateway description (byte) 0-1000

Common options

For information about the options common to all vpc subcommands, see VPC options.

Examples

If the request to edit the NAT Gateway instance description is successful, the configuration information for the NAT Gateway instance is returned.

Command

The command example is as follows:

./ncloud vpc setNatGatewayDescription \
    --natGatewayInstanceNo 56789012 \
    --natGatewayDescription "Test NAT Gateway" \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "setNatGatewayDescriptionResponse": {
    "totalRows": 1,
    "natGatewayInstanceList": [
      {
        "vpcNo": "12345678",
        "vpcName": "test-vpc-01",
        "natGatewayInstanceNo": "56789012",
        "natGatewayName": "test-natgw-01",
        "publicIp": "192.0.2.10",
        "natGatewayInstanceStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "natGatewayInstanceStatusName": "Running",
        "natGatewayInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        },
        "createDate": "2026-07-07T14:48:38+0900",
        "natGatewayDescription": "Updated NAT Gateway description",
        "zoneCode": "KR-1",
        "natGatewayType": {
          "code": "PBLIP",
          "codeName": "Public"
        },
        "subnetName": "test-natgw-subnet",
        "subnetNo": "23456789",
        "privateIp": "10.0.3.6",
        "publicIpInstanceNo": "78901234",
        "natGatewayIpList": [
          {
            "type": "PRIMARY",
            "privateIp": "10.0.3.6",
            "publicIp": "192.0.2.10",
            "publicIpInstanceNo": "78901234"
          }
        ]
      }
    ],
    "requestId": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}