Documentation
Table of Contents
proxy.get
Descripció
integer/array proxy.get(object parameters)
El mètode permet recuperar 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
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| proxyids | string/array | Retorna només proxys amb els identificadors donats. |
| selectHosts | query | Retorna una propietat equips amb els equips monitorats pel proxy. |
| selectInterface | query | Retorna una propietat interfície amb la interfície proxy emprada per un proxy passiu. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Els valors possibles són: hostid, host i status. |
| countOutput | boolean | Aquests paràmetres es descriuen als comentaris 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
Recuperar tots els proxys
Recuperar tots els proxys configurats i les seves interfícies.
Petició:
{ "jsonrpc": "2.0", "method": "proxy.get", "params": { "output": "extend", "selectInterface": "extend" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Resposta:
{ "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 }Veieu també
Font
CProxy::get() in ui/include/classes/api/services/CProxy.php.