本文へジャンプします。

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

nifty-describe-routers

処理概要

API「NiftyDescribeRouters」が実行されます。
指定したルーターの情報の取得します。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。

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

コマンド構文

nifty-describe-routers [オプション]

オプション

オプション 短縮 説明 必須
--router-id ID1 [,ID2,…]   ルーターユニークIDを指定します。  
--router-name NAME1 [,NAME2,…]   ルーター名を指定します。  
--filter "ATTRIBUTE1=VALUE1[,VALUE2,...]" [--filter "ATTRIBUTE2=VALUE1[,VALUE2,...]"] [...]   絞り込み条件を指定します。
“availability-zone =値1,値2,…” : ゾーンによる絞り込み
“state =値1,値2,…” : ルーターステータスによる絞り込み
“router-id=値1,値2,…” : ルーターユニークIDによる絞り込み
“router-name=値1,値2,…” : ルーター名による絞り込み
“description=値1,値2,…” : ルーターメモによる絞り込み
“accountingType=値1,値2,…” : ルーター利用料金タイプによる絞り込み
“type=値1,値2,…” : ルーターのタイプによる絞り込み
“ip-address=値1,値2,…” : ルーターのIPアドレスによる絞り込み
“version=値1,値2,…” : ルーターのversion情報による絞り込み
“latest-version-information=値1,値2,…” : ルーターのversionの更新情報による絞り込み
 

出力要素

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

  • ROUTER / routerId
  • ROUTER / routerName
  • ROUTER / state
  • ROUTER / availabilityZone
  • ROUTER / accountingType
  • ROUTER / nextMonthAccountingType
  • ROUTER / description
  • ROUTER / routeTableId
  • ROUTER / routeTableAssociationId
  • ROUTER / natTableId
  • ROUTER / natTableAssociationId
  • ROUTER / type
  • ROUTER / createdTime
  • VERSION_INFORMATION / isLatest
  • VERSION_INFORMATION / version
  • NETWORK_INTERFACE / networkId
  • NETWORK_INTERFACE / networkName
  • NETWORK_INTERFACE / deviceIndex
  • NETWORK_INTERFACE / ipAddress
  • NETWORK_INTERFACE / cidrBlock
  • NETWORK_INTERFACE / dhcp
  • NETWORK_INTERFACE / dhcpOptionsId
  • NETWORK_INTERFACE / dhcpConfigId
  • NETWORK_INTERFACE / description
  • BACKUP_INFORMATION / isBackup
  • BACKUP_INFORMATION / expirationDate
  • GROUP / groupId

実行サンプル

PROMPT>nifty-describe-routers --router-id rt-8db04f81 --filter "state=available"
ROUTER rt-8db04f81 routerName available east-12 2 1 memo rtb-0wr2jpc1 rtbassoc-0wr2ydqh nat-0glo3coz natassoc-0glomaez 2014-10-28T10:16:38+09:00
VERSION_INFORMATION true vyos 1.1.5
NETWORK_INTERFACE net-COMMON_GLOBAL 0 111.171.134.16 dopt-01234567 dconf-01234567 memo
BACKUP_INFORMATION true 2015/10/31
GROUP ftest1

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

APIメニュー

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

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