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. Permisos para activar el método se puede revocar en la configuración de roles de usuario. Ver User roles para más información.
(object)
Parameters defining the desired output.
The method supports the following parameters.
Parameter | Type | Description |
---|---|---|
proxyids | string/array | Return only proxies with the given IDs. |
selectHosts | query | Return a hosts property with the hosts monitored by the proxy. |
selectInterface | query | Return an interface property with the proxy interface used by a passive proxy. |
sortfield | string/array | Sort the result by the given properties. Possible values are: hostid , host and status . |
countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary. |
editable | boolean | |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(entero/matriz)
Devuelve:
countOutput
ha sido usado.Recupere todos los servidores proxy configurados y sus interfaces.
Solicitud:
{
"jsonrpc": "2.0",
"method": "proxy.get",
"params": {
"output": "extend",
"selectInterface": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Respuesta:
{
"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
}
CProxy::get() en ui/include/classes/api/services/CProxy.php.