proxy.get

Beschreibung

integer/array proxy.get(object parameters)

Mit dieser Methode können Sie Proxies anhand der angegebenen Parameter abrufen.

Diese Methode steht Benutzern jeden Typs zur Verfügung. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.
Es werden nur Proxies zurückgegeben, die durch die Proxy access list der Benutzergruppen des Benutzers zugelassen sind.

Parameter

(object) Parameter zur Definition der gewünschten Ausgabe.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
proxyids ID/array Gibt nur Proxys mit den angegebenen IDs zurück.
proxy_groupids ID/array Gibt nur Proxys zurück, die zu den angegebenen Proxy-Gruppen gehören.
selectApm query Gibt eine apm-Eigenschaft mit den Einstellungen für das Application Performance Monitoring (APM) des Proxys zurück.
selectAssignedHosts query Gibt eine assignedHosts-Eigenschaft mit den dem Proxy zugewiesenen Hosts zurück.

Unterstützt count.
selectHosts query Gibt eine hosts-Eigenschaft mit den vom Proxy überwachten Hosts zurück.

Unterstützt count.
selectProxyGroup query Gibt eine proxyGroup-Eigenschaft mit dem Proxy-Gruppenobjekt zurück.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: proxyid, name, operating_mode.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder:

  • eine Reihe von Objekten zurück;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde zurück.

Beispiele

Alle Proxys abrufen

Rufen Sie alle konfigurierten Proxys und ihre Schnittstellen ab.

Anfrage:

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

Antwort:

{
    "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
}

Siehe auch

Quelle

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