deleteNatGatewayInstance

Prev Next

VPC環境で利用できます。

NAT Gatewayインスタンス番号を指定して NAT Gatewayインスタンスを削除します。

リクエスト

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

メソッド URI
GET, POST /deleteNatGatewayInstance

リクエストヘッダ

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

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

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

パラメータ名 タイプ 必須の有無 説明
regionCode String Optional 削除対象 NAT Gatewayのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
natGatewayInstanceNo String Required 削除対象 NAT Gatewayインスタンス番号
output String Optional レスポンス結果の形式
  • xml | json(デフォルト)
returnPublicIpInstance Boolean Optional
  • true (デフォルト) | false
    • true: Public NAT Gatewayに割り当てられたグローバル IPアドレス Instanceを一緒に削除
    • false: グローバル IPアドレス Instanceはそのまま維持

リクエスト例

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

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/deleteNatGatewayInstance
?regionCode=KR
&natGatewayInstanceNo=***9734'
--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のレスポンスステータスコードをご参照ください。

レスポンス例

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

<deleteNatGatewayInstanceResponse>
  <requestId>bce9e911-5989-4285-8596-8d08966c7181</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***36</vpcNo>
      <vpcName>normal-***</vpcName>
      <natGatewayInstanceNo>*****0811</natGatewayInstanceNo>
      <natGatewayName>ng19****</natGatewayName>
      <publicIp>***.***.153.33</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>RUN状態</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Terminating</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>TERMT</code>
        <codeName>TERMINATE 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.8</privateIp>
      <publicIpInstanceNo>***810</publicIpInstanceNo>
      <natGatewayIpList>
        <natGatewayIp>
          <type>PRIMARY</type>
          <privateIp>10.0.1.8</privateIp>
          <publicIp>***.***.153.33</publicIp>
          <publicIpInstanceNo>***810</publicIpInstanceNo>
        </natGatewayIp>
      </natGatewayIpList>
    </natGatewayInstance>
  </natGatewayInstanceList>
</deleteNatGatewayInstanceResponse>