获取

描述

integer/array proxy.get(object parameters)

该方法允许根据给定的参数检索proxy。

此方法对于任何用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看 用户角色。

参数

(object) 定义所需输出的参数。

此方法支持以下参数。

参数类型描述
proxyidsstring/array仅返回具有给定 ID 的proxy。
selectHostsquery返回一个主机属性，其中包含proxy监控的主机。
selectInterfacequery返回一个接口属性， 其中包含被 被动proxy使用的proxy接口。
sortfieldstring/array按照给定的属性对结果进行排序。

可用值：hostid，host 和 status。
countOutputboolean这些参数对所有get方法是通用的，详细描述请查看参考说明。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回其中一个：

  • 一个对象数组；
  • 如果使用了countOutput参数，被检索对象的数量。

示例

检索所有proxy

检索所有已配置的proxy及其接口。

请求：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "proxy.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "selectInterface": "extend"
  7.            },
  8.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.            "id": 1
  10.        }

响应：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "host": "Active proxy",
  6.                    "status": "5",
  7.                    "lastaccess": "0",
  8.                    "description": "",
  9.                    "tls_connect": "1",
  10.                    "tls_accept": "1",
  11.                    "tls_issuer": "",
  12.                    "tls_subject": "",
  13.                    "proxy_address": "",
  14.                    "auto_compress": "0",
  15.                    "proxyid": "30091",
  16.                    "interface": []
  17.                },
  18.                {
  19.                    "host": "Passive proxy",
  20.                    "status": "6",
  21.                    "lastaccess": "0",
  22.                    "description": "",
  23.                    "tls_connect": "1",
  24.                    "tls_accept": "1",
  25.                    "tls_issuer": "",
  26.                    "tls_subject": "",
  27.                    "proxy_address": "",
  28.                    "auto_compress": "0",
  29.                    "proxyid": "30092",
  30.                    "interface": {
  31.                        "interfaceid": "30109",
  32.                        "hostid": "30092",
  33.                        "useip": "1",
  34.                        "ip": "127.0.0.1",
  35.                        "dns": "",
  36.                        "port": "10051"
  37.                    ]
  38.                }
  39.            ],
  40.            "id": 1
  41.        }

参见

来源

CProxy::get() in ui/include/classes/api/services/CProxy.php.