获取

描述

integer/array proxy.get(object parameters)

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

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

参数

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

该方法支持以下参数。

参数 类型 描述
proxyids ID/数组 仅返回具有给定ID的proxy。
proxy_groupids ID/数组 仅返回属于给定proxy组的proxy。
selectAssignedHosts 查询 返回一个assignedHosts属性,其中包含分配给proxy的hosts。

支持count
selectHosts 查询 返回一个hosts属性,其中包含由proxy监控的hosts。

支持count
selectProxyGroup 查询 返回一个proxyGroup属性,其中包含proxy组对象。
sortfield 字符串/数组 根据给定属性对结果进行排序。

可能的值:proxyidnameoperating_mode
countOutput 布尔值 这些参数在参考说明中描述。
editable 布尔值
excludeSearch 布尔值
filter 对象
limit 整数
output 查询
preservekeys 布尔值
search 对象
searchByAny 布尔值
searchWildcardsEnabled 布尔值
sortorder 字符串/数组
startSearch 布尔值

返回值

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

  • 一个对象数组;
  • 如果使用了countOutput参数,则返回检索对象的数量。

示例

检索所有proxy

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

请求:

{
           "jsonrpc": "2.0",
           "method": "proxy.get",
           "params": {
               "output": "extend",
               "selectInterface": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "name": "Active proxy",
                   "status": "5",
                   "lastaccess": "0",
                   "description": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "proxy_address": "",
                   "auto_compress": "0",
                   "proxyid": "30091",
                   "interface": []
               },
               {
                   "name": "Passive proxy",
                   "status": "6",
                   "lastaccess": "0",
                   "description": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "proxy_address": "",
                   "auto_compress": "0",
                   "proxyid": "30092",
                   "interface": {
                       "interfaceid": "30109",
                       "hostid": "30092",
                       "useip": "1",
                       "ip": "127.0.0.1",
                       "dns": "",
                       "port": "10051"
                   ]
               }
           ],
           "id": 1
       }

参见

来源

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