proxy.update

描述

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.

Documentation

proxy.update

描述

参数

返回值

示例

更改被Proxy监控的主机

更改Proxy状态

将Proxy添加到Proxy组

另请参阅

来源