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

NiftyModifyWebProxyAttribute

処理概要

ルーターに設定されたWebプロキシの詳細情報を更新します。1回のリクエストで、1つのWebプロキシの情報を更新できます。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。
受け側／迂回先ネットワークは、ルーターと紐付きのあるネットワークを指定する必要があります。

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

指定するパラメーター

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

応答フィールド

フィールド (項目)	型	説明
NiftyModifyWebProxyAttributeResponse	-	NiftyModifyWebProxyAttributeレスポンス
␣requestId	string	リクエスト識別子
␣return	boolean	処理ステータス 値: true (成功)

リクエストサンプル

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

  

応答サンプル

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