本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeDhcpStatus

処理概要

DHCPでのIP払い出し状態を表示します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouterId ルーターユニークID
Type : String

(ルーター名といずれか)
 
RouterName ルーター名
Type : String

(ルーター名といずれか)
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyDescribeDhcpStatusResponse NiftyDescribeDhcpStatusレスポンス
Type : NiftyDescribeDhcpStatusResponseType
Ancestor : なし
Children : requestId, dhcpOptionsSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribeDhcpStatusResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
routerId ルーターユニークID
Type : xsd:string
Ancestor : NiftyDescribeDhcpStatusResponse
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : NiftyDescribeDhcpStatusResponse
Children :なし
 
dhcpStatusInformationSet DHCPのステータス情報セット
Type : DhcpStatusInformationSetType
Ancestor : NiftyDescribeDhcpStatusResponse
Children : item
 
item DHCPのステータス情報
Type : DhcpStatusInformationSetItemType
Ancestor : dhcpStatusInformationSet
Children : networkId, privateLanName, dhcpIpAddressInformationSet
 
networkId ネットワークのユニークID
Type : xsd:string
Ancestor : item
Children :なし
net-8db04f81
privateLanName ネットワークの名前
Type : xsd:string
Ancestor : item
Children :なし
 
dhcpIpAddressInformation DHCPのIPアドレス情報セット
Type :DhcpIpAddressInformationType
Ancestor : item
Children : ipAddressPoolSet,dhcpIpAddressSet
 
ipAddressPoolSet プールレンジ情報セット
Type :IpAddressPoolSetType
Ancestor : dhcpIpAddressInformation
Children : item
 
item DHCPのIPアドレス情報
Type :DhcpIpAddressPoolInformationSetItemType
Ancestor : ipAddressPoolSet
Children : startIpAddress, stopIpAddress, description
 
startIpAddress 開始IPアドレス
Type :xsd:string
Ancestor : item
Children :なし
 
stopIpAddress 終了IPアドレス
Type :xsd:string
Ancestor : item
Children :なし
 
description ipAddressPoolのメモ(500字,CDATAつき)
Type :xsd:string
Ancestor : item
Children :なし
 
dhcpIpAddressSet IPアドレス情報セット
Type :DhcpIpAddressSetType
Ancestor : dhcpIpAddressInformation
Children : item
 
item IPアドレス情報
Type :DhcpIpAddressSetItemType
Ancestor : dhcpIpAddressSet
Children : startIpAddress, stopIpAddress, description
 
ipAddress IPアドレス
Type :xsd:string
Ancestor : item
Children :なし
 
macAddress MACアドレス
Type :xsd:string
Ancestor : item
Children :なし
 
leaseType dhcpの払い出し状態
Type :xsd:string
Ancestor : item
Children :なし
 
leaseExpiration IPアドレスリリース日
Type :xsd:dateTime
Ancestor : item
Children :なし
 
clientName IPアドレスが設定されているリソース名
Type :xsd:string
Ancestor : item
Children :なし
 
description StaticMappingのメモ(500字,CDATAつき)
Type : xsd:string
Ancestor : item
Children :なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyDescribeDhcpStatus&RouterId=rt-0000000z&NetworkId=net-0000000z&DhcpConfigId=dconf-0000000z&CommonParams

応答サンプル

<NiftyDescribeDhcpStatusResponse xmlns="https://cp.cloud.nifty.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>
      <leaseExpiration>2001-01-01T12:00:00</leaseExpriation>
      <clientName>vyos</clientName>
      <description><![CDATA[memo]]></description>
     </item>
    </dhcpIpAddressSet>
   </dhcpIpAddressInformationSet>
  </item>
 </dhcpStatusInformationSet>
</NiftyDescribeDhcpStatusResponse>

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

APIメニュー

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

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