本文へジャンプします。

ニフクラ APIリファレンス

DescribeDhcpOptions

処理概要

DHCPオプションの設定情報を取得します。
DHCPオプションを指定するためには、DHCPオプションが必要です。管理外のDHCPオプションを指定したなど、無効なDHCPオプションを指定した場合は、エラーが返されます。
DHCPオプションを指定しない場合は、取得可能なすべてのDHCPオプション情報を取得します。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
DhcpOptionsId.n DHCPオプションID
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : String
値: dhcp-options-id(DHCPオプションID) | key(DHCPオプション名) | value(DHCPオプションの値)
   
Filter.n.Value.m 絞り込み条件の値
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
DeleteDhcpOptionsResponse DeleteDhcpOptionsレスポンス
Type : DeleteDhcpOptionsResponseType
Ancestor : なし
Children : requestId, dhcpOptionsSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DeleteDhcpOptionsResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
dhcpOptionsSet DHCPオプションリスト情報セット
Type : DhcpOptionsType
Ancestor : DeleteDhcpOptionsResponse
Children : dhcpOptionsId, dhcpConfigurationSet
 
dhcpOptionsId DHCPオプションID
Type : xsd:string
Ancestor : dhcpOptionsSet
Children : なし
 
dhcpConfigurationSet DHCPオプション設定情報セット
Type : DhcpConfigurationSetType
Ancestor : dhcpOptionsSet
Children : item
 
item DHCPオプション設定情報
Type : DhcpConfigurationSetItemType
Ancestor : dhcpConfigurationSet
Children : key,valueSet
 
key DHCPオプション名
Type : xsd:string
Ancestor : item
Children : なし
 
valueSet DHCPオプションの値情報セット
Type : ValueSetType
Ancestor : item
Children : item
 
item DHCPオプションの値情報
Type : ValueSetItemType
Ancestor : valueSet
Children : value
 
value DHCPオプションの値
Type : xsd:string
Ancestor : item
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : dhcpOptionsSet
Children : item
 
item 設定されているタグのキー
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key,value
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeDhcpOptions&DhcpOptionsId=dopt-7a8b9c2d&CommonParams

応答サンプル

<DescribeDhcpOptionsResponsexmlns="https://cp.cloud.nifty.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>
   <tagSet/>
  </item>
 </dhcpOptionsSet>
</DescribeDhcpOptionsResponse>

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

APIメニュー

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

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