本文へジャンプします。

ニフクラ ユーザーガイド

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 DescribeRouteTablesResponseType DescribeRouteTablesレスポンス
Ancestor: なし
Children: requestId | routeTableSet
requestId string リクエスト識別子
Ancestor: DescribeRouteTablesResponse
Children: なし
routeTableSet RouteTableSetType ルートテーブルリスト情報セット
Ancestor: DescribeRouteTablesResponse
Children: item
item RouteTableSetItemType ルートテーブルリスト情報
Ancestor: routeTableSet
Children: routeTableId | vpcId | routeSet | associationSet | propagatingVgwSet | elasticLoadBalancerAssociationSet | tagSet
routeTableId string ルートテーブルID
Ancestor: item
Children: なし
vpcId string ※返却値なし
Ancestor: item
Children: なし
routeSet RouteSetType ルート情報セット
Ancestor: item
Children: item
item RouteSetItemType ルート情報
Ancestor: routeSet
Children: destinationCidrBlock | gatewayId | instanceId | instanceOwnerId | networkInterfaceId | ipAddress | networkId | networkName | state
destinationCidrBlock string 宛先のCIDR
Ancestor: item
Children: なし
gatewayId string ※返却値なし
Ancestor: item
Children: なし
instanceId string ※返却値なし
Ancestor: item
Children: なし
instanceOwnerId string ※返却値なし
Ancestor: item
Children: なし
networkInterfaceId string ※返却値なし
Ancestor: item
Children: なし
ipAddress string ターゲットのIPアドレス
Ancestor: item
Children: なし
networkId string ターゲットのネットワークID
Ancestor: item
Children: なし
networkName string ターゲットのネットワーク名
Ancestor: item
Children: なし
state string ルートの状態
値: active | blackhole
Ancestor: item
Children: なし
origin string ルート作成方法
値: CreateRouteTable | CreateRoute | EnableVgwRoutePropagation
Ancestor: item
Children: なし
priority string 優先順位
Ancestor: item
Children: なし
vpcPeeringConnectionId string VPNコネクションID(VPNゲートウェイから伝搬されたルートのみ)
Ancestor: item
Children: なし
associationSet RouteTableAssociationSetType ルートテーブル適用情報セット
Ancestor: item
Children: item
item RouteTableAssociationType ルートテーブル適用情報
Ancestor: associationSet
Children: routeTableAssociationId | routeTableId | subnetId | main | routerId | routerName
routeTableAssociationId string ルートテーブル適用ID
Ancestor: item
Children: なし
routeTableId string ルートテーブルID
Ancestor: item
Children: なし
subnetId string ※返却値なし
Ancestor: item
Children: なし
main boolean メインルートテーブルフラグ
Ancestor: item
Children: なし
routerId string ルーターユニークID
Ancestor: item
Children: なし
routerName string ルーター名
Ancestor: item
Children: なし
propagatingVgwSet PropagatingVgwSetType VPNゲートウェイ伝播経路情報セット
Ancestor: item
Children: item
item PropagatingVgwType VPNゲートウェイ伝播経路情報セット
Ancestor: propagatingVgwSet
Children: gatewayId | niftyGatewayName | routeTableAssociationId
gatewayId string VPNゲートウェイID
Ancestor: item
Children: なし
niftyGatewayName string VPNゲートウェイ名
Ancestor: item
Children: なし
routeTableAssociationId string ルートテーブル適用ID
Ancestor: item
Children: なし
elasticLoadBalancerAssociationSet elasticLoadBalancerAssociationSetType マルチロードバランサー適用情報セット
Ancestor: item
Children: item
item elasticLoadBalancerAssociationSet マルチロードバランサー適用情報
Ancestor: elasticLoadBalancerAssociationSet
Children: elasticLoadBalancerId | elasticLoadBalancerName | main | routeTableAssociationId | routeTableId
elasticLoadBalancerId string マルチロードバランサーユニークID
Ancestor: item
Children: なし
elasticLoadBalancerName string マルチロードバランサー名
Ancestor: item
Children: なし
main boolean メインルートテーブルフラグ
Ancestor: item
Children: なし
routeTableAssociationId string ルートテーブル適用ID
Ancestor: item
Children: なし
routeTableId string ルートテーブルID
Ancestor: item
Children: なし
tagSet ResourceTagSetType リソースに設定されているタグ情報セット
Ancestor: item
Children: item
item ResourceTagSetItemType リソースに設定されているタグ情報
Ancestor: tagSet
Children: key | value
key string 設定されているタグのキー
Ancestor: item
Children: なし
value string 設定されているタグの値
Ancestor: item
Children: なし

リクエストサンプル

    https://cp.cloud.nifty.com/api/?
  &Action=DescribeRouteTables
  &CommonParams

  

応答サンプル

    <DescribeRouteTablesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>6f570b0b-9c18-4b07-bdec-73740dcf861a</requestId>
  <routeTableSet>
    <item>
      <routeTableId>rtb-e4ad488d</routeTableId>
      <routeSet>
        <item>
          <destinationCidrBlock>192.164.1.0/24</destinationCidrBlock>
          <ipAddress>192.164.1.3</ipAddress>
          <networkId>net-8db04f81</networkId>
          <networkName>vlan1</networkName>
          <state>active</state>
          <origin>CreateRoute</origin>
          <priority>1</priority>
        </item>
        <item>
          <destinationCidrBlock>10.0.0.0/22</destinationCidrBlock>
          <ipAddress>cgw-da52vda6</ipAddress>
          <networkId/>
          <networkName/>
          <state>blackhole</state>
          <origin>EnableVgwRoutePropagation</origin>
          <priority>2</priority>
          <vpcPeeringConnectionId>vpn-01234567</vpcPeeringConnectionId>
        </item>
      </routeSet>
      <associationSet>
        <item>
          <routeTableAssociationId>rtbassoc-12ad487b</routeTableAssociationId>
          <routeTableId>rtb-13ad487a</routeTableId>
          <main>true</main>
          <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>
        <item>
          <elasticLoadBalancerId>elb-01234567</elasticLoadBalancerId>
          <elasticLoadBalancerName>multilb01</elasticLoadBalancerName>
          <main>true</main>
          <routeTableAssociationId>rtbassoc-22ax487d</routeTableAssociationId>
          <routeTableId>rtb-13ad487a</routeTableId>
        </item>
      </elasticLoadBalancerAssociationSet>
      <tagSet/>
    </item>
  </routeTableSet>
</DescribeRouteTablesResponse>

  

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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