proxygroup.update

説明

object proxygroup.update(object/array proxies)

このメソッドは、既存のプロキシグループを更新することができます。

このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

(object/array) 更新するプロキシグループプロパティ。

proxy_groupidプロパティはプロキシグループごとに定義する必要があり、すべてのプロパティはオプションです。渡されたプロパティのみが更新され、他のプロパティは変更されません。

このメソッドは標準プロキシグループプロパティを持つプロキシグループを受け入れます。

戻り値

(object) proxy_groupidsプロパティの下にある、更新されたプロキシグループのIDを含むオブジェクトを返す。

例

オンラインプロキシの最小数を変更する

グループがオンラインになるために必要なオンラインプロキシの最小数を変更します。

リクエスト :

{
           "jsonrpc": "2.0",
           "method": "proxygroup.update",
           "params": {
               "proxy_groupid": "5",
               "min_online": "3"
           },
           "id": 1
       }

レスポンス :

{
           "jsonrpc": "2.0",
           "result": {
               "proxy_groupids": [
                   "5"
               ]
           },
           "id": 1
       }

ソース

CProxyGroup::update() in ui/include/classes/api/services/CProxyGroup.php.

Documentation

proxygroup.update

説明

パラメーター

戻り値

例

オンラインプロキシの最小数を変更する

ソース