proxygroup.get

Descrizione

integer/array proxygroup.get(object parameters)

Il metodo consente di recuperare i gruppi di proxy in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi per chiamare il metodo possono essere revocati nelle impostazioni dei ruoli utente. Consultare Ruoli utente per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Type Descrizione
proxy_groupids ID/array Restituisce solo i gruppi di proxy con gli ID specificati.
proxyids ID/array Restituisce solo i gruppi di proxy che contengono i proxy specificati.
selectProxies query Restituisce una proprietà proxies con i proxy che appartengono al gruppo di proxy.

Supporta count.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: proxy_groupid, name.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(intero/array) Restituisce:

  • un array di oggetti;
  • il conteggio degli oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recuperare tutti i gruppi di proxy

Recupera tutti i gruppi di proxy configurati con i relativi proxy.

Richiesta:

{
"jsonrpc": "2.0",
"method": "proxygroup.get",
"params": {
"output": "extend",
"selectProxies": ["proxyid", "name"]
},
"id": 1
}

Risposta:

{
"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
}

Vedi anche

Sorgente

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