createNatGatewayInstance

Prev Next

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String リージョンコード
  • NAT Gatewayインスタンスが作成されるリージョン(Region)を決定可能
  • regionCodeはgetRegionListアクションを通じて取得可能
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
zoneCode Yes String ZONEコード
  • NAT Gatewayインスタンスが作成されるゾーン(zone)を決める
  • zoneCodeはgetZoneListアクションを通じて取得可能
vpcNo Yes String VPC番号
  • NAT Gatewayインスタンスが作成される VPCを決める
  • vpcNoはgetVpcListアクションを通じて取得可能
natGatewayName No String
  • 最小: 3、最大: 30
  • 英字の小文字、数字、記号の「-」のみ入力可能で、先頭文字は英字のみ使用
  • 末尾文字は英字または数字のみ使用
作成する NAT Gatewayの名前
  • デフォルト: NAVERクラウドプラットフォームが自動で付与
natGatewayDescription No String 最小: 0, 最大: 1000 Bytes 作成する NAT Gatewayの説明
responseFormatType No String レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: xml
publicIpInstanceNo No String Public IPアドレス Instance番号
  • Subnetが PRIVATE(subnetTypeCode)タイプの場合、無視
  • Subnetが PUBLICの場合、publicIpInstanceNoが NULLであれば自動作成、NOT-NULLであれば割り当て
privateIp No String プライベート IPアドレス
  • Subnetが PUBLICの場合、無視
  • Subnetが PUBLICの場合、NULLであれば自動割り当て、NOT-NULLであればその IPアドレスで作成
subnetNo No String NATGWタイプの SubnetNo
  • NULLの場合、PUBLICタイプの NATGW Subnetを作成
  • NOT-NULLの場合、NATGW Subnetの subnetTypeCodeに応じて NATGatewayを作成

レスポンス

レスポンスデータタイプ

NatGatewayInstanceList extends CommonResponse
private Integer totalRows;
private List<NatGatewayInstance> natGatewayInstanceList
NatGatewayInstance
private String vpcNo;
private String vpcName;
private String natGatewayInstanceNo;
private String natGatewayName;
private String publicIp;
private CommonCode natGatewayInstanceStatus;
private String natGatewayInstanceStatusName;
private CommonCode natGatewayInstanceOperation;
private Date createDate;
private String natGatewayDescription;
private String zoneCode;
private CommonCode natGatewayType;
private String subnetName;
private String subnetNo;
private String privateIp;
private String publicIpInstanceNo;
private List<NatGatewayIp> natGatewayIpList;
NatGatewayIp
private String type;
private String privateIp;
private String publicIp;
private String publicIpInstanceNo;

リクエスト例

ncloud vpc createNatGatewayInstance --regionCode KR --zoneCode KR-1 --vpcNo ***04 --natGatewayName test-*** --subnetNo ***28 --publicIpInstanceNo ***25

レスポンス例

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