createNatGatewayInstance

VPC環境で利用できます。

NAT Gatewayインスタンスを作成します。

構文

createNatGatewayInstance構文は次の通りです。

./ncloud vpc createNatGatewayInstance \
    --vpcNo <vpc-no> \
    --zoneCode <zone-code> \
    [--natGatewayName <nat-gateway-name>] \
    [--natGatewayDescription <nat-gateway-description>] \
    [--subnetNo <subnet-no>] \
    [--publicIpInstanceNo <public-ip-instance-no>] \
    [--privateIp <private-ip>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション	タイプ	必須の有無	説明
`--vpcNo`	String	Required	VPC番号 getVpcListを参照
`--zoneCode`	String	Required	ゾーンコード getZoneListを参照

任意オプション

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

オプション	タイプ	必須の有無	説明
`--natGatewayName`	String	Optional	NAT Gatewayの名前英字の小文字、数字、記号の`-`を組み合わせて3~30文字以内で入力先頭文字は英字、末尾文字は英字または数字のみ使用未入力の場合、NAVERクラウドプラットフォームが自動付与
`--natGatewayDescription`	String	Optional	作成する NAT Gatewayの説明(Byte) 0~1,000
`--subnetNo`	String	Optional	Subnet番号 `subnetNo`が NULLの場合、`PUBLIC`タイプの NAT Gateway Subnetに作成される `subnetNo`が NOT-NULLの場合、NAT Gateway Subnetの`subnetTypeCode`に応じて NAT Gatewayが作成される getSubnetListを参照
`--publicIpInstanceNo`	String	Optional	パブリック IPアドレス Instance番号 Subnetが`PRIVATE`タイプの場合、このオプションは無視される Subnetが`PUBLIC`タイプの場合 `publicIpInstanceNo`が NULLの場合、パブリック IPアドレスを自動作成 `publicIpInstanceNo`が NOT-NULLの場合、指定のパブリック IPアドレスが割り当てられっる
`--privateIp`	String	Optional	プライベート IPアドレス `privateIp`が NULLの場合、プライベート IPアドレスが自動的に割り当てられる `privateIp`が NOT-NULLの場合、指定されたプライベート IPアドレスが割り当てられる

共通オプション

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

例

NAT Gatewayインスタンスの作成リクエストが成功すると、インスタンスの構成情報と作成状態が返されます。

コマンド

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

./ncloud vpc createNatGatewayInstance \
    --vpcNo 12345678 \
    --zoneCode KR-1 \
    --natGatewayName test-natgw-01 \
    --natGatewayDescription "Test NAT Gateway" \
    --subnetNo 23456789 \
    --regionCode KR \
    --output json

出力

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

{
  "createNatGatewayInstanceResponse": {
    "totalRows": 1,
    "natGatewayInstanceList": [
      {
        "vpcNo": "12345678",
        "vpcName": "test-vpc-01",
        "natGatewayInstanceNo": "56789012",
        "natGatewayName": "test-natgw-01",
        "publicIp": "",
        "natGatewayInstanceStatus": {
          "code": "INIT",
          "codeName": "準備中"
        },
        "natGatewayInstanceStatusName": "Creating",
        "natGatewayInstanceOperation": {
          "code": "CREAT",
          "codeName": "CREAT OP"
        },
        "createDate": "2026-07-07T14:48:38+0900",
        "natGatewayDescription": "Test NAT Gateway",
        "zoneCode": "KR-1",
        "natGatewayType": {
          "code": "PBLIP",
          "codeName": "パブリック"
        },
        "subnetName": "test-natgw-subnet",
        "subnetNo": "23456789",
        "privateIp": "10.0.3.6",
        "publicIpInstanceNo": "",
        "natGatewayIpList": [
          {
            "type": "PRIMARY",
            "privateIp": "10.0.3.6",
            "publicIp": "",
            "publicIpInstanceNo": ""
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}