setNatGatewayDescription

VPC環境で利用できます。

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

構文

setNatGatewayDescription構文は次の通りです。

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

オプション

setNatGatewayDescriptionの実行時に指定できるオプションについて説明します。

必須オプション

setNatGatewayDescriptionの必須オプションです。

任意オプション

setNatGatewayDescriptionの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

共通オプション

vpcコマンドで共通して使用するオプションについては、VPCのオプションをご参照ください。

例

NAT Gatewayインスタンスの説明の変更リクエストが成功すると、NAT Gatewayインスタンスの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "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": "実行中"
        },
        "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": "パブリック"
        },
        "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"
  }
}