Documentation
Table of Contents
proxygroup.get
Descripció
integer/array proxygroup.get(object parameters)
El mètode permet recuperar grups de proxys segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(objecte) Paràmetres que defineixen la sortida desitjada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| proxy_groupids | ID/array | Retorna només els grups de proxy amb els ID donats. |
| proxyids | ID/array | Retorna només els grups de proxys que contenen els proxys donats. |
| selectProxies | query | Retorna una propietat proxies amb els proxys que pertanyen al grup de proxys.Admet count. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Valors possibles: proxy_groupid, name. |
| countOutput | boolean | Aquests paràmetres es descriuen en detall al comentari de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recupera tots els grups de proxy
Recupereu tots els grups de proxys configurats amb proxys.
{ "jsonrpc": "2.0", "method": "proxygroup.get", "params": { "output": "extend", "selectProxies": ["proxyid", "name"] }, "id": 1 }Resposta:
{ "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 }Veieu també
Font
CProxyGroup::get() in ui/include/classes/api/services/CProxyGroup.php.