createNatGatewayInstance

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /createNatGatewayInstance

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional Network ACLインスタンスを作成するリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
zoneCode String Required NAT Gatewayインスタンスを作成するゾーン
vpcNo String Required NAT Gatewayインスタンスを作成する VPC番号
natGatewayName String Optional
natGatewayDescription String Optional
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をご参照ください。

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

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

<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>