本文へジャンプします。

ニフクラ APIリファレンス

NiftyModifyWebProxyAttribute

処理概要

ルーターに設定されたWebプロキシの詳細情報を更新します。1回のリクエストで、1つのWebプロキシの情報を更新できます。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
受け側/迂回先ネットワークは、ルーターと紐付きのあるネットワークを指定する必要があります。

受け側/迂回先ネットワーク、受け側ポート、DNSサーバーのアドレスの更新時、ルーターがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

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

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

(ルーターユニークIDといずれか)
 
Attribute 更新対象の項目名
Type : String
値: listenInterface.NetworkId(Webプロキシの受け側ネットワークIDを更新) | listenInterface.NetworkName(Webプロキシの受け側ネットワーク名を更新) | listenPort(Webプロキシのポートを更新) | bypassInterface.NetworkId(Webプロキシの迂回先ネットワークIDを更新) | bypassInterface.NetworkName(Webプロキシの迂回先ネットワーク名を更新) | option-nameServer(DNSサーバのアドレス(IPv4)を更新) | description(メモを更新)
   
Value 更新値
Type : String
 
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type:boolean
Default:false

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

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyModifyWebProxyAttributeResponse NiftyModifyWebProxyAttributeレスポンス
Type : NiftyModifyWebProxyAttributeResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyModifyWebProxyAttributeResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 更新ステータス
Type : xsd:boolean
Ancestor : NiftyModifyWebProxyAttributeResponse
Children : なし
 

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyModifyWebProxyAttribute&RouterId=nrt-8db04f81&Attribute=description&Value=memoCommonParams

応答サンプル

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

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

APIメニュー

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

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