本文へジャンプします。

ニフクラ APIリファレンス

DescribeRouteTables

処理概要

指定したルートテーブルの情報を取得します。
ルートテーブルを指定するためには、ルートテーブルID が必要です。管理外のルートテーブルを指定したなど、無効なルートテーブルを指定した場合は、エラーが返されます。
ルートテーブルを指定しない場合は、取得可能なすべてのルートテーブル情報を取得します。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouteTableId .n ルートテーブルID
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : 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)
  ac501097-4c8d-475b-b06b-a90048ec181c
Filter.n.Value.m 絞り込み条件の値
Type : String
   

応答フィールド

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

リクエストサンプル

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

応答サンプル

<DescribeRouteTablesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</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>
     <vlan1>networkName</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>
     <routeTableId>rtb-13ad487a</routeTableId>
     <routerId>rt-11ad4878</routerId>
     <routerName>router01</routerName>
    </item>
   </associationSet>
   <propagatingVgwSet>
     <item>
       <gatewayId>vgw-01234567</gatewayId>
       <niftyGatewayName>vpngw001</niftyGatewayName>
       <routeTableAssociationId>rtbassoc-12ad487b</routeTableAssociationId>
     </item>
   </propagatingVgwSet>
   <tagSet/>
  </item>
 </routeTableSet>
</DescribeRouteTablesResponse>

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

APIメニュー

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

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