proxy.update

描述

object proxy.update(object/array proxies)

此方法用于 update 现有的 proxies。

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

参数

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

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

除了标准 proxy 属性之外，该方法还接受以下参数。

Parameter Type Description
hosts array 由 proxy 监控的主机。
如果某个主机已经由其他 proxy 监控，则会重新分配给当前 proxy。

这些主机只能定义 hostid 属性。

返回值

(object) 返回一个 object，其中包含更新后的 proxies 的 ID，这些 ID 位于 proxyids 属性下。

示例

更改由 proxy 监控的主机

更新 proxy 以监控给定的两个 主机。

执行请求:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "hosts": [
            {
                "hostid": "10294"
            },
            {
                "hostid": "10295"
            }
        ]
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10293"
        ]
    },
    "id": 1
}

更改 proxy 状态

将 proxy 更改为一个主动的 proxy，并将其重命名为“Active proxy”。

执行请求:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "name": "Active proxy",
        "operating_mode": "0"
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10293"
        ]
    },
    "id": 1
}

向 proxy 添加一个 proxy 组

用ID "5" 更新 proxy 并将其添加到 ID 为 "1" 的 proxy 组 中。

执行请求:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "proxyid": "5",
        "proxy_groupid": "1",
        "local_address": "127.0.0.1"
    },
    "id": 1
}

响应：

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

另请参见

来源

CProxy::update() 在 ui/include/classes/api/services/CProxy.php 中。