本文へジャンプします。

ニフクラ ユーザーガイド

DescribeRouteTables

処理概要

指定したルートテーブルの情報を取得します。
ルートテーブルを指定するためには、ルートテーブルID が必要です。
ルートテーブルを指定しない場合は、取得可能なすべてのルートテーブル情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0 個以上任意文字、「?」は1 個任意文字、「¥」はエスケープ変換文字(「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索)となります。 曖昧検索が指定可能な絞り込み条件の項目名は、association.router-name、route.destination-cidr-block、route.ip-address になります。

指定するパラメーター

パラメーター 説明 必須
RouteTableId.n string ルートテーブルID
Filter.n.Name string 絞り込み条件の項目名
値:
  • association.route-table-association-id (ルートテーブル適用ID)
  • association.route-table-id (ルートテーブル適用情報のルートテーブルID)
  • association.router-id (ルーターユニークID)
  • association.router-name (ルーター名)
  • association.main (メインルートテーブルフラグ)
  • route-table-id (ルートテーブルID)
  • route.destination-cidr-block (宛先CIDR)
  • route.gateway-id (拠点間VPNゲートウェイのユニークID)
  • route.vpc-peering-connection-id (VPNコネクションID)
  • route.origin (ルート作成方法)
  • route.state (ルートステータス)
  • route.ip-address (ターゲットのIPアドレス)
  • route.network-id (ターゲットのネットワークID)
Filter.n.Value.m string 絞り込み条件の値

応答フィールド

フィールド (項目) 説明
DescribeRouteTablesResponse - DescribeRouteTablesレスポンス
requestId string リクエスト識別子
routeTableSet - ルートテーブルリスト情報セット
item - ルートテーブルリスト情報
routeTableId string ルートテーブルID
routeSet - ルート情報セット
item - ルート情報
destinationCidrBlock string 宛先のCIDR
ipAddress string ターゲットのIPアドレス
networkId string ターゲットのネットワークID
networkName string ターゲットのネットワーク名
state string ルートの状態
値:
  • active
  • blackhole
origin string ルート作成方法
値:
  • CreateRouteTable
  • CreateRoute
  • EnableVgwRoutePropagation
priority string 優先順位
vpcPeeringConnectionId string VPNコネクションID(拠点間VPNゲートウェイから伝搬されたルートのみ)
associationSet - ルートテーブル適用情報セット
item - ルートテーブル適用情報
routeTableAssociationId string ルートテーブル適用ID
routeTableId string ルートテーブルID
main boolean メインルートテーブルフラグ
routerId string ルーターユニークID
routerName string ルーター名
propagatingVgwSet - 拠点間VPNゲートウェイ伝播経路情報セット
item - 拠点間VPNゲートウェイ伝播経路情報セット
gatewayId string 拠点間VPNゲートウェイID
niftyGatewayName string 拠点間VPNゲートウェイ名
routeTableAssociationId string ルートテーブル適用ID
elasticLoadBalancerAssociationSet - マルチロードバランサー適用情報セット
item - マルチロードバランサー適用情報
elasticLoadBalancerId string マルチロードバランサーユニークID
elasticLoadBalancerName string マルチロードバランサー名
main boolean メインルートテーブルフラグ
routeTableAssociationId string ルートテーブル適用ID
routeTableId string ルートテーブルID
tagSet - ※空を返却
リソースに設定されているタグ情報セット
item - リソースに設定されているタグ情報
key string 設定されているタグのキー
value string 設定されているタグの値

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
  Action=DescribeRouteTables
  &CommonParams

  

応答サンプル

    <DescribeRouteTablesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>6f570b0b-9c18-4b07-bdec-73740dcf861a</requestId>
  <routeTableSet>
    <item>
      <routeTableId>rtb-e4ad488d</routeTableId>
      <routeSet>
        <item>
          <destinationCidrBlock>192.0.2.0/24</destinationCidrBlock>
          <ipAddress></ipAddress>
          <networkId>net-8db04f81</networkId>
          <networkName>vlan1</networkName>
          <origin>CreateRoute</origin>
          <priority>1</priority>
          <state>active</state>
        </item>
        <item>
          <destinationCidrBlock>10.0.0.0/22</destinationCidrBlock>
          <ipAddress>cgw-da52vda6</ipAddress>
          <networkId></networkId>
          <networkName></networkName>
          <origin>EnableVgwRoutePropagation</origin>
          <priority>2</priority>
          <state>active</state>
          <vpcPeeringConnectionId>vpn-01234567</vpcPeeringConnectionId>
        </item>
      </routeSet>
      <associationSet>
        <item>
          <main>true</main>
          <routeTableAssociationId>rtbassoc-12ad487b</routeTableAssociationId>
          <routeTableId>rtb-e4ad488d</routeTableId>
          <routerId>rt-11ad4878</routerId>
          <routerName>router01</routerName>
        </item>
      </associationSet>
      <propagatingVgwSet>
        <item>
          <gatewayId>vgw-01234567</gatewayId>
          <niftyGatewayName>vpngw001</niftyGatewayName>
          <routeTableAssociationId>rtbassoc-1xad2x7c</routeTableAssociationId>
        </item>
      </propagatingVgwSet>
      <elasticLoadBalancerAssociationSet/>
      <tagSet/>
    </item>
    <item>
      <routeTableId>rtb-00000kh0</routeTableId>
      <routeSet>
        <item>
          <destinationCidrBlock>192.0.2.0/24</destinationCidrBlock>
          <ipAddress>192.0.2.3</ipAddress>
          <origin>CreateRoute</origin>
          <priority>1</priority>
          <state>blackhole</state>
        </item>
      </routeSet>
      <associationSet/>
      <propagatingVgwSet/>
      <elasticLoadBalancerAssociationSet>
        <item>
          <elasticLoadBalancerId>elb-01234567</elasticLoadBalancerId>
          <elasticLoadBalancerName>multilb01</elasticLoadBalancerName>
          <main>true</main>
          <routeTableAssociationId>rtbassoc-22ax487d</routeTableAssociationId>
          <routeTableId>rtb-00000kh0</routeTableId>
        </item>
      </elasticLoadBalancerAssociationSet>
      <tagSet/>
    </item>
  </routeTableSet>
</DescribeRouteTablesResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年10月20日時点の情報です。

推奨画面サイズ 1024×768 以上