getNatGatewayInstanceDetail

Available in VPC

Get NAT Gateway instance details by specifying the NAT Gateway instance number.

Syntax

The getNatGatewayInstanceDetail syntax is as follows:

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

Options

This section describes the options available when running getNatGatewayInstanceDetail.

Required options

The following options are required for getNatGatewayInstanceDetail.

Common options

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

Examples

If the request to retrieve NAT Gateway instance details is successful, the NAT Gateway instance's configuration information is returned.

Command

The command example is as follows:

./ncloud vpc getNatGatewayInstanceDetail \
    --natGatewayInstanceNo 56789012 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getNatGatewayInstanceDetailResponse": {
    "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": "Test NAT Gateway",
        "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": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}