createNatGatewayInstance

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
regionCode	No	String		- リージョンコード NAT Gatewayインスタンスが作成されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得できる Default: getRegionList照会結果の最初のリージョンを選択
zoneCode	Yes	String		- ZONEコード NAT Gatewayインスタンスが作成されるゾーン(zone)を決定 zoneCodeは、getZoneListアクションを通じて取得できる
vpcNo	Yes	String		- VPC番号 NAT Gatewayインスタンスが作成される VPCを決定 vpcNoは、getVpcListアクションを通じて取得できる
natGatewayName	No	String	Min: 3, Max: 30 英字の小文字、数字、特殊文字の「-」のみ入力でき、先頭文字は英字にすること末尾文字は英字または数字にすること	- 作成する NAT Gateway名 Default: NAVERクラウドプラットフォームが自動的に付与
natGatewayDescription	No	String	Min: 0, Max: 1000 Bytes	作成する NAT Gatewayに対する説明
responseFormatType	No	String		- レスポンス結果のフォーマットタイプ Options: xml \| json Default: xml
publicIpInstanceNo	No	String		- グローバル IPアドレスインスタンス番号 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のタイプ

NatGatewayInstanceList extends CommonResponse
private Integer totalRows;
private List natGatewayInstanceList = new ArrayList<>();

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;

例

リクエスト例

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

レスポンス例

<createNatGatewayInstanceResponse>
  <requestId>4475d78c-4c27-4404-807d-7b0b645bb127</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
        <vpcNo>***36</vpcNo>
        <vpcName>test-vpc</vpcName>
        <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
        <natGatewayName>test-***</natGatewayName>
        <publicIp>***.***.109.101</publicIp>
        <natGatewayInstanceStatus>
            <code>INIT</code>
            <codeName>init</codeName>
        </natGatewayInstanceStatus>
        <natGatewayInstanceStatusName>準備中</natGatewayInstanceStatusName>
        <natGatewayInstanceOperation>
            <code>NULL</code>
            <codeName>NULL OP</codeName>
        </natGatewayInstanceOperation>
        <createDate>2023-04-18T15:13:27+0900</createDate>
        <natGatewayDescription></natGatewayDescription>
        <zoneCode>KR-1</zoneCode>
        <natGatewayType>
            <code>PBLIP</code>
            <codeName>Public</codeName>
        </natGatewayType>
        <subnetName>v-kr1-pub-natgw-***</subnetName>
        <subnetNo>***28</subnetNo>
        <privateIp>10.0.***.***</privateIp>
        <publicIpInstanceNo>***25</publicIpInstanceNo>
    </natGatewayInstance>
  </natGatewayInstanceList>
</createNatGatewayInstanceResponse>

この記事は役に立ちましたか?

What's Next

deleteNatGatewayInstance

概要
リクエスト
レスポンス
例

タグ