NiftyDescribeRouters
処理概要
指定したルーターの情報の取得をします。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。
ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0 個以上任意文字、「?」は1 個任意文字、「¥」はエスケープ変換文字（「¥∗niftycloud¥?¥¥ 」は「∗niftycloud?¥」を検索）となります。曖昧検索が指定可能な絞り込み条件の項目名、router-name、description になります。
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| RouterId.n | string |
ルーターユニークID |
|
| RouterName.n | string |
ルーター名 |
|
| Filter.n.Name | string |
絞り込み条件の項目名 値:
|
|
| Filter.n.Value.m | string |
絞り込み条件の項目の値 Default: なし |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| NiftyDescribeRoutersResponse | - |
NiftyDescribeRouters レスポンス |
| ␣requestId | string |
リクエスト識別子 |
| ␣routerSet | - |
ルーター情報セット |
| ␣␣item | - |
ルーター情報 |
| ␣␣␣routerId | string |
ルーターユニークID |
| ␣␣␣routerName | string |
ルーター名 |
| ␣␣␣state | string |
ルーターのステータス 値:
|
| ␣␣␣availabilityZone | string |
ゾーン情報 |
| ␣␣␣tagSet | - |
※空を返却 リソースに設定されているタグ情報セット |
| ␣␣␣␣item | - |
リソースに設定されているタグ情報 |
| ␣␣␣␣␣key | string |
設定されているタグのキー |
| ␣␣␣␣␣value | string |
設定されているタグの値 |
| ␣␣␣accountingType | string |
利用料金タイプ 値:
|
| ␣␣␣nextMonthAccountingType | string |
次月からの利用料金タイプ 値:
|
| ␣␣␣description | string |
ルーターのメモ(CDATA付) |
| ␣␣␣versionInformation | - |
ルータのversion情報 |
| ␣␣␣␣isLatest | boolean |
ルータのversion最新状態 |
| ␣␣␣␣version | string |
ルータのversion情報 |
| ␣␣␣networkInterfaceSet | - |
ネットワークインターフェース情報セット |
| ␣␣␣␣item | - |
ネットワークインターフェース情報 |
| ␣␣␣␣␣networkId | string |
ネットワークユニークID |
| ␣␣␣␣␣networkName | string |
ネットワーク名 |
| ␣␣␣␣␣deviceIndex | string |
デバイス番号 |
| ␣␣␣␣␣ipAddress | string |
IPアドレス |
| ␣␣␣␣␣cidrBlock | string |
ネットワークのCIDR |
| ␣␣␣␣␣dhcp | boolean |
dhcp設定フラグ |
| ␣␣␣␣␣dhcpOptionsId | string |
dhcpオプションID |
| ␣␣␣␣␣dhcpConfigId | string |
dhcpコンフィグID |
| ␣␣␣␣␣description | string |
ネットワークのメモ(CDATA付) |
| ␣␣␣routeTableId | string |
ルートテーブルID |
| ␣␣␣routeTableAssociationId | string |
ルートテーブル適用ID |
| ␣␣␣natTableId | string |
natテーブルID |
| ␣␣␣natTableAssociationId | string |
natテーブル適用ID |
| ␣␣␣backupInformation | - |
バックアップ情報セット |
| ␣␣␣␣expirationDate | timestamp |
バックアップの保持期限 |
| ␣␣␣␣isBackup | boolean |
バックアップが存在するか |
| ␣␣␣type | string |
ルーターのタイプ |
| ␣␣␣groupSet | - |
ファイアウォール情報セット |
| ␣␣␣␣item | - |
ネットワークのメモ |
| ␣␣␣␣␣groupId | string |
ネットワークのメモ |
| ␣␣␣createdTime | timestamp |
作成日時 |
リクエストサンプル
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>
