NiftyDescribeDhcpStatus
処理概要
DHCPでのIP払い出し状態を表示します。
指定するパラメーター
パラメーター |
型 |
説明 |
必須 |
RouterId |
string |
ルーターユニークID
|
○ (ルーター名といずれか)
|
RouterName |
string |
ルーター名
|
○ (ルーターユニークIDといずれか)
|
応答フィールド
フィールド (項目) |
型 |
説明 |
NiftyDescribeDhcpStatusResponse |
- |
NiftyDescribeDhcpStatusレスポンス
|
␣requestId |
string |
リクエスト識別子
|
␣routerId |
string |
ルーターユニークID
|
␣routerName |
string |
ルーター名
|
␣dhcpStatusInformationSet |
- |
DHCPのステータス情報セット
|
␣␣item |
- |
DHCPのステータス情報
|
␣␣␣networkId |
string |
ネットワークのユニークID
|
␣␣␣privateLanName |
string |
ネットワークの名前
|
␣␣␣dhcpIpAddressInformation |
- |
DHCPのIPアドレス情報セット
|
␣␣␣␣ipAddressPoolSet |
- |
プールレンジ情報セット
|
␣␣␣␣␣item |
- |
DHCPのIPアドレス情報
|
␣␣␣␣␣␣startIpAddress |
string |
開始IPアドレス
|
␣␣␣␣␣␣stopIpAddress |
string |
終了IPアドレス
|
␣␣␣␣␣␣description |
string |
ipAddressPoolのメモ(500字,CDATAつき)
|
␣␣␣␣dhcpIpAddressSet |
- |
IPアドレス情報セット
|
␣␣␣␣␣item |
- |
IPアドレス情報
|
␣␣␣␣␣␣ipAddress |
string |
IPアドレス
|
␣␣␣␣␣␣macAddress |
string |
MACアドレス
|
␣␣␣␣␣␣leaseType |
string |
dhcpの払い出し状態
|
␣␣␣␣␣␣leaseExpiration |
timestamp |
IPアドレスリリース日
|
␣␣␣␣␣␣clientName |
string |
IPアドレスが設定されているリソース名
|
␣␣␣␣␣␣description |
string |
StaticMappingのメモ(500字,CDATAつき)
|
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyDescribeDhcpStatus
&RouterId=rt-0000000z
&CommonParams
応答サンプル
<NiftyDescribeDhcpStatusResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<routerId>rt-01234567</routerId>
<routerName>router001</routerName>
<dhcpStatusInformationSet>
<item>
<networkId>net-01234567</networkId>
<privateLanName>network001</privateLanName>
<dhcpIpAddressInformation>
<ipAddressPoolSet>
<item>
<startIpAddress>192.168.0.16</startIpAddress>
<stopIpAddress>192.168.0.128</stopIpAddress>
<description><![CDATA[memo]]></description>
</item>
</ipAddressPoolSet>
<dhcpIpAddressSet>
<item>
<ipAddress>192.168.0.25</ipAddress>
<macAddress>07:00:30:1B:92:44</macAddress>
<leaseType>dynamic</leaseType>
<clientName>vyos</clientName>
<description><![CDATA[memo]]></description>
</item>
</dhcpIpAddressSet>
</dhcpIpAddressInformation>
</item>
</dhcpStatusInformationSet>
</NiftyDescribeDhcpStatusResponse>