proxy.update

描述

object proxy.update(object/array proxies)

此方法允许update现有的proxies.

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

参数

(object/array) Proxy 待更新的属性.

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

除proxy外，该方法还接受以下参数。

参数 数据类型 描述
hosts array 由proxy监控的Hosts。
若一个主机已被其他proxy监控，将被重新分配给当前proxy。

主机必须仅定义hostid属性。

返回值

(object) 返回一个包含更新后objectID的proxies数组，存储在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并重命名为"活动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 文件中。