NiftyDescribeDhcpConfigs
処理概要
DHCPコンフィグ情報を取得します。
DHCPコンフィグを指定するためには、DHCPコンフィグIDが必要です。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 | string |
DHCPコンフィグID |
|
Filter.n.Name | 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 | string |
絞り込み条件の値 |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
NiftyDescribeDhcpConfigsResponse | - |
NiftyDescribeDhcpConfigsレスポンス Ancestor: なし Children: requestId | dhcpConfigsSet |
requestId | string |
リクエスト識別子 Ancestor: NiftyDescribeDhcpConfigsResponse Children: なし |
dhcpConfigsSet | - |
DHCPコンフィグ情報セット Ancestor: NiftyDescribeDhcpConfigsResponse Children: item |
item | - |
DHCPコンフィグ情報 Ancestor: dhcpConfigsSet Children: dhcpConfigId | ipAddressPoolsSet | staticMappingsSet |
dhcpConfigId | string |
DHCPコンフィグID Ancestor: item Children: なし |
ipAddressPoolsSet | - |
ipAddressPool情報セット Ancestor: item Children: item |
item | - |
ipAddressPool情報 Ancestor: ipAddressPoolsSet Children: startIpAddress | stopIpAddress | description |
startIpAddress | string |
開始IPアドレス Ancestor: item Children: なし |
stopIpAddress | string |
終了IPアドレス Ancestor: item Children: なし |
description | string |
メモ(CDATA付き) Ancestor: item Children: なし |
staticMappingsSet | - |
staticMappings情報セット Ancestor: item Children: item |
item | - |
staticMappings情報 Ancestor: staticMappingsSet Children: ipAddress | macAddress | description |
ipAddress | string |
IPアドレス Ancestor: item Children: なし |
macAddress | string |
MACアドレス Ancestor: item Children: なし |
description | string |
メモ(CDATA付き) Ancestor: item Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyDescribeDhcpConfigs
&CommonParams
応答サンプル
<NiftyDescribeDhcpConfigsResponse xmlns="https://computing.api.nifcloud.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><![CDATA[MEMO]]></description>
</item>
</ipAddressPoolsSet>
<staticMappingsSet>
<item>
<ipAddress>192.168.0.1</ipAddress>
<macAddress>7f:43:27:fa:0a:88</macAddress>
<description><![CDATA[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><![CDATA[MEMO]]></description>
</item>
</ipAddressPoolsSet>
<staticMappingsSet>
<item>
<ipAddress>127.0.0.1</ipAddress>
<macAddress>1a:72:cd:3s:4f:96</macAddress>
<description><![CDATA[MEMO]]></description>
</item>
</staticMappingsSet>
</item>
</dhcpConfigsSet>
</NiftyDescribeDhcpConfigsResponse>