removeRoute

Prev Next

VPC環境で利用できます。

ルーティングテーブルに設定されたルートリストを削除します。デフォルトで設定されているルートは削除できません。

リクエスト

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

メソッド URI
GET, POST /removeRoute

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional ルート削除対象ルーティングテーブルのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
vpcNo String Required ルーティングテーブルの VPC番号
routeTableNo String Required ルーティングテーブル番号
  • ルート削除対象のルーティングテーブル番号
  • getRouteTableListを通じて確認
routeList.N.destinationCidrBlock String Required 削除対象ルートの目的地 IPv4アドレスの範囲
  • CIDR表記を使用
  • <例>routeList.1.destinationCidrBlock=0.0.0.0/0&routeList.2.destinationCidrBlock=100.10.20.0/24
routeList.N.targetTypeCode String Required 削除対象ルートの目的地タイプ
  • NATGW | VPCPEERING | VGW
    • NATGW: NAT Gateway
    • VPCPEERING: VPC Peering
    • VGW: Virtual Private Gateway
    • <例>routeList.1.targetTypeCode=NATGW&routeList.2.targetTypeCode=VPCPEERING
routeList.N.targetNo String Required 削除対象ルートの目的地の識別番号
  • 各目的地タイプに当てはまるリソースリストを照会する APIを通じて確認
  • <例>routeList.1.targetNo=1234&routeList.2.targetNo=2345
routeList.N.targetName String Required 削除対象ルートの目的地名
  • 各目的地タイプに当てはまるリソースリストを照会する APIを通じて確認
  • <例>routeList.1.targetName=test-natgateway&routeList.2.targetName=test-peering
responseFormatType String Optional

リクエスト例

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

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/removeRoute
?regionCode=KR
&vpcNo=***04
&routeTableNo=***38
&routeList.1.destinationCidrBlock=***.***.200.0/24
&routeList.1.targetTypeCode=NATGW
&routeList.1.targetNo=***9734
&routeList.1.targetName=test-***'
--header 'x-ncp-iam-access-key: {Timestamp}'    
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、RouteListをご参照ください。

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

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

レスポンス例

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

<removeRouteResponse>
  <requestId>fb1ea6cf-15bf-4600-b737-1d7bed33421e</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>2</totalRows>
  <routeList>
    <route>
      <destinationCidrBlock>***.***.0.0/16</destinationCidrBlock>
      <targetName>LOCAL</targetName>
      <routeTableNo>***38</routeTableNo>
      <targetType>
        <code>LOCAL</code>
        <codeName>Local</codeName>
      </targetType>
      <targetNo></targetNo>
      <isDefault>true</isDefault>
    </route>
    <route>
      <destinationCidrBlock>***.***.0.0/0</destinationCidrBlock>
      <targetName>INTERNET GATEWAY</targetName>
      <routeTableNo>***38</routeTableNo>
      <targetType>
        <code>IGW</code>
        <codeName>Internet Gateway</codeName>
      </targetType>
      <targetNo></targetNo>
      <isDefault>true</isDefault>
    </route>
  </routeList>
</removeRouteResponse>