Documentation
Table of Contents
proxy.get
Descripción
integer/array proxy.get(object parameters)
El método permite recuperar proxies según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| proxyids | cadena/matriz | Devuelve solo servidores proxy con los ID proporcionados. |
| selectHosts | query | Devuelve una propiedad hosts con los equipos monitoreados por el proxy. |
| selectInterface | query | Devuelve una propiedad interface con la interfaz proxy utilizada por un proxy pasivo. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Valores posibles: hostid, host, status. |
| countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de devueltos
(integer/array) Returns either:
- una matriz de objetos;
- la suma de los objetos devueltos, si el parámetro
countOutputestá siendo usado
Ejemplos
Recuperar todos los servidores proxy
Recupere todos los servidores proxy configurados y sus interfaces.
{
"jsonrpc": "2.0",
"method": "proxy.get",
"params": {
"output": "extend",
"selectInterface": "extend"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"host": "Active proxy",
"status": "5",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_address": "",
"auto_compress": "0",
"version": "60400",
"compatibility": "1",
"proxyid": "30091",
"interface": []
},
{
"host": "Passive proxy",
"status": "6",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_address": "",
"auto_compress": "0",
"lastaccess": "0",
"version": "0",
"compatibility": "0",
"proxyid": "30092",
"interface": {
"interfaceid": "30109",
"hostid": "30092",
"main": "1",
"type": "0",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10051",
"available": "0",
"error": "",
"errors_from": "0",
"disable_until": "0",
"details": []
}
}
],
"id": 1
}Ver también
Fuente
CProxy::get() en ui/include/classes/api/services/CProxy.php.