setNatGatewayDescription

VPC 환경에서 이용 가능합니다.

NAT Gateway 인스턴스 번호를 지정하여 NAT Gateway 인스턴스에 대한 설명을 수정합니다.

구문

setNatGatewayDescription 구문은 다음과 같습니다.

./ncloud vpc setNatGatewayDescription \
    --natGatewayInstanceNo <nat-gateway-instance-no> \
    [--natGatewayDescription <nat-gateway-description>] \
    [--regionCode <KR|KRS>] \
    [--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": "vpc01",
        "natGatewayInstanceNo": "56789012",
        "natGatewayName": "test-natgw-01",
        "publicIp": "192.0.2.10",
        "natGatewayInstanceStatus": {
          "code": "RUN",
          "codeName": "RUN 상태"
        },
        "natGatewayInstanceStatusName": "Running",
        "natGatewayInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        },
        "createDate": "2026-07-20T10:14:18+0900",
        "natGatewayDescription": "Test NAT Gateway",
        "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": "6540931c-fcd2-47c1-97e5-0c6939141037",
    "returnCode": "0",
    "returnMessage": "success"
  }
}