本文へジャンプします。

ニフティクラウド APIリファレンス

nifty-describe-route-tables

処理概要

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

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

コマンド構文

nifty-describe-route-tables [オプション]

オプション

オプション 短縮 説明 必須
--route-table-id ID1 [,ID2 ,...]   ルートテーブルIDを指定します。  
--filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...]   絞り込み条件を指定します。
"association.route-table-association-id=値1,値2,..." : ルートテーブル適用IDによる絞り込み
"association.route-table-id=値1,値2,..." : ルートテーブル適用情報のルートテーブルIDによる絞り込み
"association.router-id=値1,値2,..." : ルーターユニークIDによる絞り込み
"association.router-name=値1,値2,..." : ルーター名による絞り込み
"association.main=値1,値2,..." : メインルートテーブルフラグによる絞り込み
"route-table-id=値1,値2,..." : ルートテーブルIDによる絞り込み
"route.destination-cidr-block=値1,値2,..." : 宛先CIDRによる絞り込み
"route.gateway-id=値1,値2,..." : VPNゲートウェイのユニークIDによる絞り込み
"route.vpc-peering-connection-id=値1,値2,..." : VPNコネクションIDによる絞り込み
"route.origin=値1,値2,..." : ルート作成方法による絞り込み
"route.state=値1,値2,..." : ルートステータスによる絞り込み
"route.ip-address=値1,値2,..." : ターゲットのIPアドレスによる絞り込み
"route.network-id=値1,値2,..." : ターゲットのネットワークIDによる絞り込み
 

出力要素

※ニフティクラウドAPIの応答フィールド名を記述します。

  • ROUTETABLE / routeTableId
  • ROUTETABLE / vpcId
  • ROUTE / destinationCidrBlock
  • ROUTE / gatewayId
  • ROUTE / instanceId
  • ROUTE / instanceOwnerId
  • ROUTE / networkInterfaceId
  • ROUTE / ipAddress
  • ROUTE / networkId
  • ROUTE / networkName
  • ROUTE / state
  • ROUTE / origin
  • ROUTE / priority
  • ROUTE / vpcPeeringConnectionId
  • ASSOCIATION / routeTableAssociationId
  • ASSOCIATION / routeTableId
  • ASSOCIATION / subnetId
  • ASSOCIATION / main
  • ASSOCIATION / routerId
  • ASSOCIATION / routerName
  • PROPAGATINGVGW / gatewayId
  • PROPAGATINGVGW / niftyGatewayName
  • PROPAGATINGVGW / routeTableAssociationId

実行サンプル

PROMPT>nifty-describe-route-tables
ROUTETABLE rtb-e4ad488d
ROUTE 192.164.1.0/24 192.164.1.3 net-8db04f81 vlan1 active CreateRoute 1
ROUTE 10.0.0.0/22 cgw-da52vda6 blackhole EnableVgwRoutePropagation 2 vpn-01234567
ASSOCIATION rtbassoc-12ad487b rtb-13ad487a true rt-11ad4878 router01
PROPAGATINGVGW vgw-01234567 vpngw001 rtbassoc-12ad487b

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

APIメニュー

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

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