获取

描述

integer/array proxygroup.get(object parameters)

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

此方法适用于任何类型的用户。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅 用户角色。

参数

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

该方法支持以下参数。

参数 类型 描述
proxy_groupids ID/array 仅返回具有给定 ID 的Proxy组。
proxyids ID/array 仅返回包含给定代理的Proxy组。
selectProxies query 返回一个 proxies 属性，其中包含属于Proxy组的Proxy。

支持 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) 返回以下任一值：

  • 包含对象的数组；
  • 如果已使用 countOutput 参数，则返回检索到的对象的数量。

示例

检索所有Proxy组

检索所有已配置的Proxy组（含Proxy）。

请求:

{
    "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”：“ 10 m”，“ min_online”：“ 3”，“ description”：“”，“ state”：“ 3”，“ proxies”：[{“
                proxyid”：“ 3”，“ name”：“ Proxy 3”
            }, {“
                proxyid”：“ 4”，“ name”：“ Proxy 4”
            }, {“
                proxyid”：“ 5”，“ name”：“ Proxy 5”
            }]
        }
    ],
    “id”： 1
}

另请参阅

来源

ui/include/classes/api/services/CProxyGroup.php 中的 CProxyGroup::get()。