createNatGatewayInstance

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET、POST	/createNatGatewayInstance

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	Network ACLインスタンスを作成する対象のリージョンコード照会結果の最初のリージョン(デフォルト) getRegionListを通じて確認
`zoneCode`	String	Required	NAT Gatewayインスタンスを作成する対象のゾーン `zoneCode`はgetZoneListを通じて確認
`vpcNo`	String	Required	NAT Gatewayインスタンスを作成する対象の VPC番号 getVpcListを通じて確認
	`networkAclName`	String	Optional
	`networkAclDescription`	String	Optional
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`
`publicIpInstanceNo`	String	Optional	グローバル IPアドレス Instance番号 Subnetが`PRIVATE`タイプの場合、このパラメータは無視される Subnetが`PUBLIC`タイプで `publicIpInstanceNo`が NULLの場合、グローバル IPアドレスが自動で作成される `publicIpInstanceNo`が NOT-NULLの場合、指定のグローバル IPアドレスが割り当てられる
`privateIp`	String	Optional	プライベート IPアドレス Subnetが`PRIVATE`タイプの場合、このパラメータは無視される Subnetが`PUBLIC`タイプで `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>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>Creating</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

リクエスト
レスポンス

タグ