proxy.get

Descripción

integer/array proxy.get(object parameters)

El método permite recuperar proxies según los parámetros especificados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración del rol de usuario. Consulte Roles de usuario para obtener más información.
Solo se devuelven los proxies permitidos por la Lista de acceso de proxy de los grupos de usuarios del usuario.

Parámetros

(object) Parámetros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
proxyids ID/array Devuelve solo los proxy con los ID indicados.
proxy_groupids ID/array Devuelve solo los proxy que pertenecen a los grupos de proxy indicados.
selectApm query Devuelve una propiedad apm con la configuración de monitorización del rendimiento de las aplicaciones (APM) del proxy.
selectAssignedHosts query Devuelve una propiedad assignedHosts con los host asignados al proxy.

Admite count.
selectHosts query Devuelve una propiedad hosts con los host monitorizados por el proxy.

Admite count.
selectProxyGroup query Devuelve una propiedad proxyGroup con el objeto del grupo de proxy.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: proxyid, name, operating_mode.
countOutput boolean Estos parámetros se describen en los comentarios de referencia.
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) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar todos los proxies

Recuperar todos los proxies configurados y sus interfaces.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "proxy.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}

Respuesta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxyid": "11",
            "name": "Active proxy",
            "proxy_groupid": "0",
            "local_address": "",
            "local_port": "10051",
            "operating_mode": "0",
            "description": "",
            "allowed_addresses": "",
            "address": "127.0.0.1",
            "port": "10051",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "custom_timeouts": "0",
            "timeout_zabbix_agent": "",
            "timeout_simple_check": "",
            "timeout_snmp_agent": "",
            "timeout_external_check": "",
            "timeout_db_monitor": "",
            "timeout_http_agent": "",
            "timeout_ssh_agent": "",
            "timeout_telnet_agent": "",
            "timeout_script": "",
            "last_access": "1693391880",
            "version": "70000",
            "compatibility": "1",
            "state": "1"
        },
        {
            "proxyid": "12",
            "name": "Passive proxy",
            "proxy_groupid": "1",
            "local_address": "127.0.0.1",
            "local_port": "10051",
            "operating_mode": "1",
            "description": "",
            "allowed_addresses": "",
            "address": "127.0.0.1",
            "port": "10051",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "custom_timeouts": "1",
            "timeout_zabbix_agent": "5s",
            "timeout_simple_check": "5s",
            "timeout_snmp_agent": "5s",
            "timeout_external_check": "5s",
            "timeout_db_monitor": "5s",
            "timeout_http_agent": "5s",
            "timeout_ssh_agent": "5s",
            "timeout_telnet_agent": "5s",
            "timeout_script": "5s",
            "lastaccess": "1693391875",
            "version": "60400",
            "compatibility": "2",
            "state": "2"
        }
    ],
    "id": 1
}

Ver también

Origen

CProxy::get() en ui/include/classes/api/services/CProxy.php.