getRouteList

Prev Next

VPC環境で利用できます。

ルーティングテーブルに設定されたルートリストを照会します。

リクエスト

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

メソッド URI
GET, POST /getRouteList

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional ルーティングリスト照会対象ルーティングテーブルのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
  • routeTableNo String Required
    vpcNo String Required ルーティングテーブルの VPC番号
  • getVpcListアクションを通じて取得可能
  • responseFormatType String Optional

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getRouteList
    ?regionCode=KR
    &routeTableNo=***38
    &vpcNo=***04'  
    --header 'x-ncp-apigw-timestamp: {Timestamp}'     
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <getRouteListResponse>
      <requestId>97b1034c-e030-40b8-bc22-58da1c3e5b0b</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>
    </getRouteListResponse>