更新

描述

object proxy.update(object/array proxies)

此方法允许更新现有Proxy。

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

参数

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

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

标准 proxy 属性外,该方法还接受以下参数。

参数 类型 说明
hosts array 由该 proxy 监控的主机
如果某个主机已由其他 proxy 监控,则会将其重新分配给当前 proxy。

这些主机必须仅定义 hostid 属性。

返回值

(object)返回一个对象,该对象包含proxyids属性下更新的Proxy的 ID。

示例

更改被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,并将其重命名为“Acitve Proxy”。

请求:

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "name": "Acitve 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() in ui/include/classes/api/services/CProxy.php.