Documentation
Table of Contents
proxygroup.get
描述
integer/array proxygroup.get(object parameters)
该方法允许根据给定的参数检索proxy 组。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见 User roles。
参数
(object) 用于定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| proxy_groupids | ID/array | 仅返回具有指定ID的proxy 组。 |
| proxyids | ID/array | 仅返回包含指定proxies的proxy 组。 |
| selectProxies | query | 返回一个proxies属性，包含属于proxy 组的proxies。支持 count。 |
| sortfield | string/array | 按照指定属性对结果进行排序。 可能的值： proxy_groupid、name。 |
| countOutput | boolean | 这些参数在通用get方法参数中有描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下之一：
- objects 的 array；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
检索所有 proxy 组
检索所有已配置的 proxy 组 与 proxies。
执行请求:
{ "jsonrpc": "2.0", "method": "proxygroup.get", "params": { "output": "extend", "selectProxies": ["proxyid", "name"] }, "id": 1 }响应:
{ "jsonrpc": "2.0", "result": [ { "proxy_groupid": "1", "name": "Proxy group 1", "failover_delay": "1m", "min_online": "3", "description": "", "state": "1", "proxies": [ { "proxyid": "1", "name": "proxy 1" }, { "proxyid": "2", "name": "proxy 2" } ] }, { "proxy_groupid": "2", "name": "Proxy group 2", "failover_delay": "10m", "min_online": "3", "description": "", "state": "3", "proxies": [ { "proxyid": "3", "name": "proxy 3" }, { "proxyid": "4", "name": "proxy 4" }, { "proxyid": "5", "name": "proxy 5" } ] } ], "id": 1 }另请参阅
来源
CProxyGroup::get() 在 ui/include/classes/api/services/CProxyGroup.php 中。