integer/array proxygroup.get(parámetros del objeto)
El método permite recuperar grupos de proxies según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.
(object)
Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
Parámetro | Tipo | Descripción |
---|---|---|
proxy_groupids | ID/array | Devolver solo los grupos de proxy con los IDs dados. |
proxyids | ID/array | Devolver solo los grupos de proxy que contienen los proxies dados. |
selectProxies | query | Devolver una propiedad proxies con los proxies que pertenecen al grupo de proxy.Admite count . |
sortfield | string/array | Ordenar el resultado por las propiedades dadas. Valores posibles: proxy_groupid , name . |
countOutput | boolean | Estos parámetros se describen en el comentario de referencia. |
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)
Devuelve:
countOutput
.Recupera todos los grupos de proxies configurados con proxies.
{
"jsonrpc": "2.0",
"method": "proxygroup.get",
"params": {
"output": "extend",
"selectProxies": ["proxyid", "name"]
},
"id": 1
}
Respuesta:
{
"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() en ui/include/classes/api/services/CProxyGroup.php.