NiftyDescribeRouters
処理概要
指定したルーターの情報の取得をします。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0 個以上任意文字、「?」は1 個任意文字、「¥」はエスケープ変換文字(「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索)となります。曖昧検索が指定可能な絞り込み条件の項目名、router-name、description になります。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
RouterId.n | string |
ルーターユニークID |
|
RouterName.n | string |
ルーター名 |
|
Filter.n.Name | 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 | string |
絞り込み条件の項目の値 Default: なし |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
NiftyDescribeRoutersResponse | - |
NiftyDescribeRouters レスポンス Ancestor: なし Children: requestId | routerSet |
requestId | string |
リクエスト識別子 Ancestor: NiftyDescribeRoutersResponse Children: なし |
routerSet | - |
ルーター情報セット Ancestor: NiftyDescribeRoutersResponse Children: item |
item | - |
ルーター情報 Ancestor: routerSet Children: routerId | routerName | state | availabilityZone | tagSet | accountingType | nextMonthAccountingType | description | versionInformation | networkInterfaceSet | routeTableId | routeTableAssociationId | natTableId | natTableAssociationId | backupInformation | type | groupSet | createdTime |
routerId | string |
ルーターユニークID Ancestor: item Children: なし |
routerName | string |
ルーター名 Ancestor: item Children: なし |
state | string |
ルーターのステータス 値: pending(処理中) | available(起動中) | stopped(停止済み) | warning(異常あり) Ancestor: item Children: なし |
availabilityZone | string |
ゾーン情報 Ancestor: item Children: なし |
tagSet | - |
※空を返却 リソースに設定されているタグ情報セット Ancestor: item Children: item |
item | - |
リソースに設定されているタグ情報 Ancestor: tagSet Children: key | value |
key | string |
設定されているタグのキー Ancestor: item Children: なし |
value | string |
設定されているタグの値 Ancestor: item Children: なし |
accountingType | string |
利用料金タイプ 値: 1(月額課金) | 2(従量課金) Ancestor: item Children: なし |
nextMonthAccountingType | string |
次月からの利用料金タイプ 値: 1(月額課金) | 2(従量課金) Ancestor: item Children: なし |
description | string |
ルーターのメモ(CDATA付) Ancestor: item Children: なし |
versionInformation | - |
ルータのversion情報 Ancestor: item Children: isLatest | version |
isLatest | boolean |
ルータのversion最新状態 Ancestor: versionInformation Children: なし |
version | string |
ルータのversion情報 Ancestor: versionInformation Children: なし |
networkInterfaceSet | - |
ネットワークインターフェース情報セット Ancestor: item Children: item |
item | - |
ネットワークインターフェース情報 Ancestor: networkInterfaceSet Children: networkId | networkName | deviceIndex | ipAddress | cidrBlock | dhcp | dhcpOptionsId | dhcpConfigId | description |
networkId | string |
ネットワークユニークID Ancestor: item Children: なし |
networkName | string |
ネットワーク名 Ancestor: item Children: なし |
deviceIndex | integer |
デバイス番号 Ancestor: item Children: なし |
ipAddress | string |
IPアドレス Ancestor: item Children: なし |
cidrBlock | string |
ネットワークのCIDR Ancestor: item Children: なし |
dhcp | boolean |
dhcp設定フラグ Ancestor: item Children: なし |
dhcpOptionsId | string |
dhcpオプションID Ancestor: item Children: なし |
dhcpConfigId | string |
dhcpコンフィグID Ancestor: item Children: なし |
description | string |
ネットワークのメモ(CDATA付) Ancestor: item Children: なし |
routeTableId | string |
ルートテーブルID Ancestor: item Children: なし |
routeTableAssociationId | string |
ルートテーブル適用ID Ancestor: item Children: なし |
natTableId | string |
natテーブルID Ancestor: item Children: なし |
natTableAssociationId | string |
natテーブル適用ID Ancestor: item Children: なし |
backupInformation | - |
バックアップ情報セット Ancestor: item Children: expirationDate | isBackup |
expirationDate | timestamp |
バックアップの保持期限 Ancestor: backupInformation Children: なし |
isBackup | boolean |
バックアップが存在するか Ancestor: backupInformation Children: なし |
type | string |
ルーターのタイプ Ancestor: item Children: なし |
groupSet | - |
ファイアウォール情報セット Ancestor: item Children: item |
item | - |
ネットワークのメモ Ancestor: groupSet Children: groupId |
groupId | string |
ネットワークのメモ Ancestor: item Children: なし |
createdTime | timestamp |
作成日時 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://computing.api.nifcloud.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>
<tagSet/>
<accountingType>2</accountingType>
<nextMonthAccountingType>1</nextMonthAccountingType>
<description><![CDATA[memo]]></description>
<versionInformation>
<isLatest>true</isLatest>
<version>v3.2</version>
</versionInformation>
<networkInterfaceSet>
<item>
<networkId>net-00000jpm</networkId>
<networkName>network</networkName>
<deviceIndex>4</deviceIndex>
<ipAddress>192.168.0.1</ipAddress>
<cidrBlock>192.168.0.0/24</cidrBlock>
<dhcp>true</dhcp>
<dhcpOptionsId>dopt-01234567</dhcpOptionsId>
<dhcpConfigId>dconf-01234567</dhcpConfigId>
<description><![CDATA[memo]]></description>
</item>
</networkInterfaceSet>
<routeTableId>rtb-0wr2jpc1</routeTableId>
<routeTableAssociationId>rtbassoc-0wr2ydqh</routeTableAssociationId>
<natTableId>nat-0glo3coz</natTableId>
<natTableAssociationId>natassoc-0glomaez</natTableAssociationId>
<backupInformation>
<expirationDate>2015/10/31</expirationDate>
<isBackup>true</isBackup>
</backupInformation>
<type>small</type>
<groupSet>
<item>
<groupId>ftest1</groupId>
</item>
</groupSet>
<createdTime>2014-10-28T10:16:38+09:00</createdTime>
</item>
</routerSet>
</NiftyDescribeRoutersResponse>