Table of Contents
proxy.get
frontend### Descri??o
integer/array proxy.get(object parameters)
O m¨¦todo permite recuperar proxies de acordo com os par?metros fornecidos.
Este m¨¦todo est¨¢ dispon¨ªvel para usu¨¢rios de qualquer tipo. As permiss?es para chamar o m¨¦todo podem ser revogadas nas configura??es de fun??o do usu¨¢rio. Consulte Fun??es de usu¨¢rio para obter mais informa??es.
Par?metros
(object) Par?metros que definem a sa¨ªda desejada.
O m¨¦todo suporta os seguintes par?metros.
| Par?metro | Tipo | Descri??o |
|---|---|---|
| proxyids | string/array | Retornar apenas proxies com os IDs fornecidos. |
| selectHosts | query | Retorna uma propriedade hosts com os hosts monitorados pelo proxy. |
| selectInterface | query | Retornar uma propriedade interface com a interface de proxy usada por um proxy passivo. |
| sortfield | string/array | Classifique o resultado pelas propriedades fornecidas. Os valores poss¨ªveis s?o: hostid, host e status. |
| countOutput | boolean | Esses par?metros sendo comuns para todos os m¨¦todos get s?o descritos em detalhes no coment¨¢rio 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 |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o par?metro
countOutputfoi usado.
Exemplos
Recupere todos os proxies
Recupere todos os proxies configurados e suas interfaces.
Request:
{
"jsonrpc": "2.0",
"method": "proxy.get",
"params": {
"output": "extend",
"selectInterface": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"host": "Active proxy",
"status": "5",
"lastaccess": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_address": "",
"auto_compress": "0",
"proxyid": "30091",
"interface": []
},
{
"host": "Passive proxy",
"status": "6",
"lastaccess": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_address": "",
"auto_compress": "0",
"proxyid": "30092",
"interface": {
"interfaceid": "30109",
"hostid": "30092",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10051"
]
}
],
"id": 1
}Veja tamb¨¦m
Fonte
CProxy::get() in ui/include/classes/api/services/CProxy.php.