proxygroup.update

描述

object proxygroup.update(object/array proxyGroups)

此方法用于 update 现有的 proxy 组。

此方法仅适用于 超级管理员 用户类型。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见 User roles

参数

(object/array) 要更新的 proxy group 属性。

必须为每个 proxy group 定义 proxy_groupid 属性,其他所有属性均为可选。只有传入的属性会被更新,其余属性将保持不变。

该方法接受具有标准 proxy group 属性的 proxy group。

返回值

(object) 返回一个 object,其中包含更新后的 proxy 组 的 ID,这些 ID 位于 proxy_groupids 属性下。

示例

更改在线proxies的最小数量

更改组处于联机状态所需的最小在线proxies数。

执行请求:

{
    "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() 在 ui/include/classes/api/services/CProxyGroup.php 中。