ニフクラAPI (コンピューティング: DescribeDhcpOptions)

DescribeDhcpOptions

処理概要

DHCPオプションの設定情報を取得します。
DHCPオプションを指定するためには、DHCPオプションが必要です。
DHCPオプションを指定しない場合は、取得可能なすべてのDHCPオプション情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。
曖昧検索が指定可能な絞り込み条件の項目名は、key、valueになります。

指定するパラメーター

パラメーター	型	説明	必須
DhcpOptionsId.n	string	DHCPオプションID
Filter.n.Name	string	絞り込み条件の項目名 値: dhcp-options-id (DHCPオプションID) key (DHCPオプション名) value (DHCPオプションの値)
Filter.n.Value.m	string	絞り込み条件の値 値: Filter.n.Name=key の場合 default-router (デフォルトゲートウェイのIPアドレス) domain-name (クライアントがホストの名前解決で使用するドメイン名) domain-name-servers (DNSサーバーのIPアドレス) ntp-servers (NTPサーバーのIPアドレス) netbios-name-servers (NetBIOSサーバーのIPアドレス) netbios-node-type (NetBIOSのノードタイプ) lease-time (IPアドレスのリースタイム)

応答フィールド

フィールド (項目)	型	説明
DescribeDhcpOptionsResponse	-	DescribeDhcpOptionsレスポンス
␣requestId	string	リクエスト識別子
␣dhcpOptionsSet	-	DHCPオプションリスト情報セット
␣␣item	-	DHCPオプションリスト情報
␣␣␣dhcpOptionsId	string	DHCPオプションID
␣␣␣dhcpConfigurationSet	-	DHCPオプション設定情報セット
␣␣␣␣item	-	DHCPオプション設定情報
␣␣␣␣␣key	string	DHCPオプション名 値: default-router (デフォルトゲートウェイのIPアドレス) domain-name (クライアントがホストの名前解決で使用するドメイン名) domain-name-servers (DNSサーバーのIPアドレス) ntp-servers (NTPサーバーのIPアドレス) netbios-name-servers (NetBIOSサーバーのIPアドレス) netbios-node-type (NetBIOSのノードタイプ) lease-time (IPアドレスのリースタイム)
␣␣␣␣␣valueSet	-	DHCPオプションの値情報セット
␣␣␣␣␣␣item	-	DHCPオプションの値情報
␣␣␣␣␣␣␣value	string	DHCPオプションの値

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeDhcpOptions
  &DhcpOptionsId=dopt-7a8b9c2d
  &CommonParams

  

応答サンプル

    <DescribeDhcpOptionsResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <dhcpOptionsSet>
    <item>
      <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>
      <dhcpConfigurationSet>
        <item>
          <key>domain-name-servers</key>
          <valueSet>
            <item>
              <value>10.2.5.1</value>
            </item>
            <item>
              <value>10.2.5.2</value>
            </item>
          </valueSet>
        </item>
      </dhcpConfigurationSet>
    </item>
  </dhcpOptionsSet>
</DescribeDhcpOptionsResponse>