NiftyDescribeDhcpConfigs
処理概要
DHCPコンフィグ情報を取得します。
DHCPコンフィグを指定するためには、DHCPコンフィグIDが必要です。管理外のDHCPコンフィグを指定したなど、無効なDHCPコンフィグを指定した場合は、エラーが返されます。
DHCPコンフィグを指定しない場合は、取得可能なすべてのDHCPコンフィグ情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。
「∗」は0個以上任意文字、「?」は1個任意文字、「\」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。
曖昧検索が指定可能な絞り込み条件の項目名は、ipaddress-pool-start, ipaddress-pool-stop, ipaddress-pool-description, static-mapping-ipaddress, static-mapping-macaddress, static-mapping-descriptionになります。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| DhcpConfigId.n | DHCPコンフィグID Type:String |
||
| Filter.n.Name | 絞り込み条件の項目名 Type:String 値:dhcp-config-id(DHCPコンフィグID) | ipaddress-pool-start(ipAddressPoolの開始IPアドレス) | ipaddress-pool-stop(ipAddressPoolの終了IPアドレス) | ipaddress-pool-description(ipAddressPoolのメモ) | static-mapping-ipaddress(staticMappingのIPアドレス) | static-mapping-macaddress(staticMappingのMACアドレス) | static-mapping-description(staticMappingのメモ) |
||
| Filter.n.Value.m | 絞り込み条件の値 Type:String |
応答フィールド
| フィールド（項目） | 説明 | サンプル値 |
|---|---|---|
| NiftyDescribeDhcpConfigsResponse | NiftyDescribeDhcpConfigsレスポンス Type : NiftyDescribeDhcpConfigsResponseType Ancestor :なし Children : requestId, dhcpConfigsSet |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : NiftyDescribeDhcpConfigsResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| dhcpConfigsSet | DHCPコンフィグ情報セット Type :DhcpConfigsSetType Ancestor : NiftyDescribeDhcpConfigsResponse Children : item |
|
| item | DHCPコンフィグ情報 Type :DhcpConfigSetItemType Ancestor : dhcpConfigsSet Children : dhcpConfigId, ipAddressPoolsSet, staticMappingsSet |
|
| dhcpConfigId | DHCPコンフィグID Type :xsd:string Ancestor : item Children :なし |
|
| ipAddressPoolsSet | ipAddressPool情報セット Type :IpAddressPoolsSetType Ancestor : item Children : item |
|
| item | ipAddressPool情報 Type :IpAddressPoolsSetItemType Ancestor : ipAddressPoolsSet Children : startIpAddress, stopIpAddress, description |
|
| startIpAddress | 開始IPアドレス Type : xsd:string Ancestor : item Children :なし |
|
| stopIpAddress | 終了IPアドレス Type : xsd:string Ancestor : item Children :なし |
|
| description | メモ Type : xsd:string Ancestor : item Children :なし |
|
| staticMappingsSet | staticMappings情報セット Type : StaticMappingsSetType Ancestor : item Children : item |
|
| item | staticMappings情報 Type : StaticMappingsSetItemType Ancestor : staticMappingsSet Children : ipAddress, macAddress, description |
|
| ipAddress | IPアドレス Type : xsd:string Ancestor : item Children :なし |
|
| macAddress | MACアドレス Type : xsd:string Ancestor : item Children :なし |
|
| description | メモ Type : xsd:string Ancestor : item Children :なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyDescribeDhcpConfigs&CommonParams 応答サンプル
<NiftyDescribeDhcpConfigsResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<dhcpConfigsSet>
<item>
<dhcpConfigId>dconf-0000000z</dhcpConfigId>
<ipAddressPoolsSet>
<item>
<startIpAddress>192.168.0.1</startIpAddress>
<stopIpAddress>192.168.0.10</stopIpAddress>
<description>MEMO</description>
</item>
</ipAddressPoolsSet>
<staticMappingsSet>
<item>
<ipAddress>192.168.0.1</ipAddress>
<macAddress>7f:43:27:fa:0a:88</macAddress>
<description>MEMO</description>
</item>
</staticMappingsSet>
</item>
<item>
<dhcpConfigId>dconf-0gj0080x</dhcpConfigId>
<ipAddressPoolsSet>
<item>
<startIpAddress>127.0.0.1</startIpAddress>
<stopIpAddress>127.0.0.10</stopIpAddress>
<description>MEMO</description>
</item>
</ipAddressPoolsSet>
<staticMappingsSet>
<item>
<ipAddress>127.0.0.1</ipAddress>
<macAddress>1a:72:cd:3s:4f:96</macAddress>
<description>MEMO</description>
</item>
</staticMappingsSet>
</item>
</dhcpConfigsSet>
</NiftyDescribeDhcpConfigsResponse> 
