NiftyDescribeRouters
処理概要
指定したルーターの情報の取得をします。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0 個以上任意文字、「?」は1 個任意文字、「¥」はエスケープ変換文字（「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索）となります。 曖昧検索が指定可能な絞り込み条件の項目名、router-name、description になります。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| RouterId.n | ルーターユニークID Type : String |
||
| RouterName.n | ルーター名 Type : String |
||
| Filter.n.Name | 絞り込み条件の項目名 Type : String 値: availability-zone(ゾーン) | state(ルーターステータス) | router-id(ルーターユニークID) | router-name(ルーター名) | description(ルーターメモ) | accountingType(ルーター利用料金タイプ) | type（ルーターのタイプ）| ip-address(ルーターのIPアドレス) | version(ルーターのversion情報) | latest-version-information(ルーターのversionの更新情報) Default: なし |
||
| Filter.n.Value.m | 絞り込み条件の項目の値 Type : String Default: なし |
応答フィールド
| フィールド（項目） | 説明 | サンプル値 |
|---|---|---|
| NiftyDescribeRoutersResponse | NiftyDescribeRouters レスポンス Type : NiftyDescribeRoutersResponseType Ancestor : なし Children : requestId, routerSet |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : NiftyDescribeRoutersResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| routerSet | ルーター情報セット Type : routerSetType Ancestor : NiftyDescribeRoutersResponse Children : item |
|
| item | ルーター情報 Type : routerType Ancestor : routerSet Children : routerId,routerName,state,availabilityZone,tagSet,accountingType,nextMonthAccountingType,description,networkInterfaceSet, routeTableId,routeTableAssociationId,natTableId,natTableAssociationId,type,groupSet,createdTime |
|
| routerId | ルーターユニークID Type : xsd:string Ancestor : item Children : なし |
|
| routerName | ルーター名 Type : xsd:string Ancestor : item Children : なし |
|
| state | ルーターのステータス Type : xsd:string 値 : pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり) Ancestor : item Children : なし |
|
| availabilityZone | ゾーン情報 Type : xsd:string Ancestor : item Children : なし |
|
| tagSet | リソースに設定されているタグ情報セット Type : ResourceTagSetType Ancestor : item Children : item |
|
| item | リソースに設定されているタグ情報 Type : ResourceTagType Ancestor : tagSet Children : key,value |
|
| key | 設定されているタグのキー Type : xsd:string Ancestor : item Children : なし |
|
| value | 設定されているタグの値 Type : xsd:string Ancestor : item Children : なし |
|
| accountingType | 利用料金タイプ Type : xsd:string 値 : 1 (月額課金) | 2 (従量課金) Ancestor : item Children : なし |
|
| nextMonthAccountingType | 次月からの利用料金タイプ Type : xsd:string 値 : 1 (月額課金) | 2 (従量課金) Ancestor : item Children : なし |
|
| description | ルーターのメモ Type : xsd:string Ancestor : item Children : なし |
|
| versionInformation | ルータのversion情報 Type :VersionInformationType Ancestor :item Children :isLatest, version |
|
| isLatest | ルータのversion最新状態 Type :xsd:boolean Ancestor :versionInformation Children :なし |
|
| version | ルータのversion情報 Type :xsd:string Ancestor :versionInformation Children :なし |
|
| networkInterfaceSet | ネットワークインターフェース情報セット Type : NetworkInterfaceSetType Ancestor : item Children : item |
|
| item | ネットワークインターフェース情報 Type : NetworkInterfaceSetItemType Ancestor : networkInterfaceSet Children : networkId,networkName,deviceIndex,ipAddress,cidrBlock,dhcp,dhcpOptionsId,description |
|
| networkId | ネットワークユニークID Type : xsd:string Ancestor : item Children : なし |
|
| networkName | ネットワーク名 Type : xsd:string Ancestor : item Children : なし |
|
| deviceIndex | デバイス番号 Type : xsd:integer Ancestor : item Children : なし |
|
| ipAddress | IPアドレス Type : xsd:string Ancestor : item Children : なし |
|
| cidrBlock | ネットワークのCIDR Type : xsd:string Ancestor : item Children : なし |
|
| dhcp | dhcp設定フラグ Type : xsd:boolean Ancestor : item Children : なし |
|
| dhcpOptionsId | dhcpオプションID Type : xsd:string Ancestor : item Children : なし |
|
| dhcpConfigId | dhcpコンフィグID Type :xsd:string Ancestor :item Children :なし |
|
| description | ネットワークのメモ Type : xsd:string Ancestor : item Children : なし |
|
| routeTableId | ルートテーブルID Type : xsd:string Ancestor : item Children : なし |
|
| routeTableAssociationId | ルートテーブル適用ID Type : xsd:string Ancestor : item Children : なし |
|
| natTableId | natテーブルID Type : xsd:string Ancestor : item Children : なし |
|
| natTableAssociationId | natテーブル適用ID Type : xsd:string Ancestor : item Children : なし |
|
| backupInformation | バックアップ情報セット Type :BackupInformationType Ancestor :item Children :isBackup, expirationDate |
|
| isBackup | バックアップが存在するか Type :xsd:boolean Ancestor :backupInformation Children :なし |
|
| expirationDate | バックアップの保持期限 Type :xsd:dateTime Ancestor :backupInformation Children :なし |
|
| type | ルーターのタイプ Type : xsd:string 値 : small | medium | large Ancestor : item Children : なし |
|
| groupSet | ファイアウォール情報セット Type : GroupSetType Ancestor : item Children : item |
|
| item | ネットワークのメモ Type : GroupItemType Ancestor : groupSet Children : groupId |
|
| groupId | ネットワークのメモ Type : xsd:string Ancestor : item Children : なし |
|
| createdTime | 作成日時 Type : xsd: dateTime Ancestor : item Children : なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyDescribeRouters&RouterId.1=rt-8db04f81&Filter.1.Name=state&Filter.1.Value.1=available&CommonParams応答サンプル
<NiftyDescribeRoutersResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<routerSet>
<item>
<routerId>nrt-8db04f81</routerId>
<routerName>routerName</routerName>
<state>available</state>
<availabilityZone>east-12</availabilityZone>
<accountingType>2</accountingType>
<nextMonthAccountingType>1</nextMonthAccountingType>
<description>memo</description>
<versionInformation>
<isLatest>true</isLatest>
<version>vyos 1.1.5</version>
</versionInformation>
<networkInterfaceSet>
<item>
<niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
<deviceIndex>0</deviceIndex>
<ipAddress>111.171.134.16</ipAddress>
<dhcpOptionsId>dopt-01234567</dhcpOptionsId>
<dhcpConfigId>dconf-01234567</dhcpConfigId>
<description>memo</description>
</item>
</networkInterfaceSet>
<routeTableId>rtb-0wr2jpc1</routeTableId>
<routeTableAssociationId>rtbassoc-0wr2ydqh</routeTableAssociationId>
<natTableId>nat-0glo3coz</natTableId>
<natTableAssociationId>natassoc-0glomaez</natTableAssociationId>
<backupInformation>
<isBackup>true</isBackup>
<expirationDate>2015/10/31</expirationDate>
</backupInformation>
<groupSet>
<item>
<groupId>ftest1</groupId>
</item>
</groupSet>
<createdTime>2014-10-28T10:16:38+09:00</createdTime>
</item>
</routerSet>
</NiftyDescribeRoutersResponse> 
