本文へジャンプします。

ニフクラ APIリファレンス

NiftyReplaceDhcpOption

処理概要

ルーターに登録されたDHCPオプションを解除し、指定したDHCPオプションに入れ替えます。

ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

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

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

(ルーター名といずれか)
 
NetworkId ネットワークユニークID
Type : String

(ネットワーク名といずれか)
 
NetworkName ネットワーク名
Type : String

(ネットワークユニークIDといずれか)
 
DhcpOptionsId 変更するDHCPオプションID
Type : String
 
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type:bBoolean
Default:false

(バックアップを保持する場合のみ)
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyReplaceDhcpOptionResponse NiftyReplaceDhcpOptionレスポンス
Type : NiftyReplaceDhcpOptionResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyReplaceDhcpOptionResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 処理結果
Type : xsd:boolean
Ancestor : NiftyReplaceDhcpOptionResponse
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyReplaceDhcpOption&RouterId=rt-8db04f81&NetworkId=net-6dd04c54&DhcpOptionsId=dopt-7a8b9c2d&CommonParams

応答サンプル

<NiftyReplaceDhcpOptionResponse xmlns="https://cp.cloud.nifty.com/api/1.20/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <return>true</return>
</NiftyReplaceDhcpOptionResponse>

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

APIメニュー

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

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