getRouteTableList

Prev Next

VPC環境で利用できます。

ユーザーが指定した条件に基づいてルーティングテーブルリストを照会します。

リクエスト

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

メソッド URI
GET, POST /getRouteTableList

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional ルーティングテーブルリスト照会対象のリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
  • routeTableNoList.N List<String> Optional ルーティングテーブル番号リストで照会
  • routeTableNogetRouteTableListを通じて確認
  • <例>routeTableNoList.1=1234&routeTableNoList.2=2345
  • routeTableName String Optional ルーティングテーブル名で照会
    supportedSubnetTypeCode String Optional ルーティングテーブルがサポートするサブネットタイプで照会
    • PUBLIC | PRIVATE
      • PUBLIC: グローバルサブネット
      • PRIVATE: プライベートサブネット
    vpcNo String Optional VPC番号で照会
  • getVpcListを通じて確認
  • pageNo Integer Optional
    pageSize Integer Conditional
    sortedBy String Optional ルーティングテーブルリスト照会時に結果をソートする基準
  • routeTableName
  • sortingOrder String Optional sortedBy利用時のソート順所
    • ASC (デフォルト) | DESC
      • ASC: 昇順
      • DESC: 降順
    responseFormatType String Optional レスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getRouteTableList
    ?regionCode=KR
    &routeTableNoList.1=***38
    &routeTableName=test-table
    &supportedSubnetTypeCode=PUBLIC
    &vpcNo=3804'  
    --header 'x-ncp-apigw-timestamp: {Timestamp}'     
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <getRouteTableListResponse>
      <requestId>43623734-4270-463f-a269-a624cdef9154</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <routeTableList>
        <routeTable>
          <routeTableNo>***38</routeTableNo>
          <routeTableName>test-***</routeTableName>
          <regionCode>KR</regionCode>
          <vpcNo>**04</vpcNo>
          <supportedSubnetType>
            <code>PUBLIC</code>
            <codeName>Public</codeName>
          </supportedSubnetType>
          <isDefault>false</isDefault>
          <routeTableStatus>
            <code>RUN</code>
            <codeName>run</codeName>
          </routeTableStatus>
          <routeTableDescription></routeTableDescription>
        </routeTable>
      </routeTableList>
    </getRouteTableListResponse>