createNatGatewayInstance

VPC環境で利用できます。

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vpc/v2/createNatGatewayInstance

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

VPC APIで共通して使用されるヘッダの詳細は、VPCのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	Network ACLインスタンスを作成するリージョンコード照会結果の最初のリージョン(デフォルト) getRegionListを参照
`zoneCode`	String	Required	NAT Gatewayインスタンスを作成するゾーン `zoneCode`はgetZoneListを参照
`vpcNo`	String	Required	NAT Gatewayインスタンスを作成する VPC番号 getVpcListを参照
`natGatewayName`	String	Optional	作成する NAT Gatewayの名前 NAVERクラウドプラットフォームが自動付与(デフォルト) 英字の小文字、数字、記号の「-」を使用して3~30文字以内で入力、先頭文字は英字のみを、末尾文字は英字または数字のみ使用
`natGatewayDescription`	String	Optional	作成する NAT Gatewayの説明 0~1000Bytes
`output`	String	Optional	レスポンス結果の形式 `xml` \| `json`(デフォルト)
`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アドレスが割り当てられる
`subnetNo`	String	Optional	NAT Gatewayインスタンスを作成する Subnet番号 `subnetNo`が NULLの場合、`PUBLIC`タイプの NAT Gateway Subnetに作成される `subnetNo`が NOT-NULLの場合、NAT Gateway Subnetの`subnetTypeCode`に応じて NAT Gatewayが作成される

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/createNatGatewayInstance
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***04
&natGatewayName=test-***
&subnetNo=***28
&publicIpInstanceNo=***25' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、NatGatewayInstanceListをご参照ください。

レスポンスステータスコード

VPC APIで共通して使用されるレスポンスステータスコードの詳細は、VPCのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<createNatGatewayInstanceResponse>
  <requestId>fae73c15-7b8d-4c09-80c2-21d46a327c4d</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***36</vpcNo>
      <vpcName>normal-***</vpcName>
      <natGatewayInstanceNo>*****9288</natGatewayInstanceNo>
      <natGatewayName>public-***</natGatewayName>
      <publicIp></publicIp>
      <natGatewayInstanceStatus>
        <code>INIT</code>
        <codeName>INIT状態</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Creating</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>CREAT</code>
        <codeName>CREAT OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2025-05-08T18:38:25+0900</createDate>
      <natGatewayDescription></natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
      <natGatewayType>
        <code>PBLIP</code>
        <codeName>グローバル</codeName>
      </natGatewayType>
      <subnetName>public-***</subnetName>
      <subnetNo>***29</subnetNo>
      <privateIp>10.0.1.6</privateIp>
      <publicIpInstanceNo></publicIpInstanceNo>
      <natGatewayIpList>
        <natGatewayIp>
          <type>PRIMARY</type>
          <privateIp>10.0.1.8</privateIp>
          <publicIp></publicIp>
          <publicIpInstanceNo></publicIpInstanceNo>
        </natGatewayIp>
      </natGatewayIpList>
    </natGatewayInstance>
  </natGatewayInstanceList>
</createNatGatewayInstanceResponse>