Anhang 1. Referenzkommentar

Notation

Datentypen

Die Zabbix-API unterstützt die folgenden Datentypen als Eingabe:

Verhalten von Eigenschaften

Einige der Objekteigenschaften sind mit kurzen Bezeichnungen versehen, um ihr Verhalten zu beschreiben. Die folgenden Bezeichnungen werden verwendet:

• schreibgeschützt - der Wert der Eigenschaft wird automatisch gesetzt und kann vom Benutzer nicht definiert oder geändert werden, auch nicht unter bestimmten Bedingungen (z. B. schreibgeschützt für geerbte oder entdeckte Objekte);
• nur schreibbar - der Wert der Eigenschaft kann gesetzt, danach jedoch nicht mehr abgerufen werden;
• konstant - der Wert der Eigenschaft kann beim Erstellen eines Objekts gesetzt, danach jedoch nicht mehr geändert werden;
• unterstützt - der Wert der Eigenschaft muss nicht gesetzt werden, darf jedoch unter bestimmten Bedingungen gesetzt werden (z. B. unterstützt, wenn type auf "Simple check", "External check", "SSH agent", "TELNET agent" oder "HTTP agent" gesetzt ist); beachten Sie jedoch, dass unterstützte Eigenschaften unabhängig von den Bedingungen weiterhin auf ihre Standardwerte gesetzt werden können;
• erforderlich - der Wert der Eigenschaft muss für alle Operationen (außer get-Operationen) oder unter bestimmten Bedingungen gesetzt werden (z. B. erforderlich für create-Operationen; erforderlich, wenn operationtype auf "global script" gesetzt ist und opcommand_hst nicht gesetzt ist).

Eigenschaften, die nicht mit Bezeichnungen versehen sind, sind optional.

Verhalten von Parametern

Einige der Operationsparameter sind mit kurzen Bezeichnungen versehen, um ihr Verhalten für die Operation zu beschreiben. Die folgenden Bezeichnungen werden verwendet:

• schreibgeschützt - der Wert des Parameters wird automatisch gesetzt und kann vom Benutzer nicht definiert oder geändert werden, auch nicht unter bestimmten Bedingungen (z. B. schreibgeschützt für geerbte Objekte oder entdeckte Objekte);
• nur schreiben - der Wert des Parameters kann gesetzt, danach jedoch nicht mehr abgerufen werden;
• unterstützt - der Wert des Parameters muss nicht gesetzt werden, darf jedoch unter bestimmten Bedingungen gesetzt werden (z. B. unterstützt, wenn operating_mode des Proxy-Objekts auf "passive proxy" gesetzt ist); beachten Sie jedoch, dass unterstützte Parameter unabhängig von den Bedingungen weiterhin auf ihre Standardwerte gesetzt werden können;
• erforderlich - der Wert des Parameters muss gesetzt werden.

Parameter, die nicht mit Bezeichnungen versehen sind, sind optional.

Reservierter ID-Wert "0"

Der reservierte ID-Wert "0" kann zum Filtern von Elementen und zum Entfernen referenzierter Objekte verwendet werden. Um zum Beispiel einen referenzierten Proxy von einem Host zu entfernen, sollte die proxyid auf 0 gesetzt werden ("proxyid": "0") oder zum Filtern von Hosts, die von der Server-Option proxyids überwacht werden, sollte der Wert auf 0 gesetzt werden ("proxyids": "0").“

Allgemeine Parameter der Methode "get"

Die folgenden Parameter werden von allen get-Methoden unterstützt:

Flags für den Entitätsursprung

Get-Methoden geben eine Eigenschaft flags für Entitäten zurück, die mit Low-Level-Discovery zusammenhängen (LLD-Regel/LLD-Regelprototyp, Datenpunkt/Datenpunktprototyp usw.). Diese Eigenschaft ist nützlich, um anzugeben, ob die Entität entdeckt wurde oder nicht, da die Bearbeitung für entdeckte Entitäten eingeschränkt ist.

Die Eigenschaft flags gibt ein Ergebnis zurück, das auf einer Kombination (Operation „+“) dieser Werte basiert:

Der von der Eigenschaft flags zurückgegebene kombinierte Wert kann sein:

Beispiele

Benutzerberechtigungsprüfung

Hat der Benutzer die Berechtigung, auf Hosts zu schreiben, deren Namen mit "MySQL" oder "Linux" beginnen? Anfrage:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "countOutput": true,
        "search": {
            "host": ["MySQL", "Linux"]
        },
        "editable": true,
        "startSearch": true,
        "searchByAny": true
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": "0",
    "id": 1
}

Mismatch-Zählung

Zählt die Anzahl der Hosts, deren Namen die Teilzeichenkette "ubuntu" nicht enthalten.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "countOutput": true,
        "search": {
            "host": "ubuntu"
        },
        "excludeSearch": true
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": "44",
    "id": 1
}

Suche nach Hosts mithilfe von Platzhaltern

Suche nach Hosts, deren Name das Wort "Server" enthält und die Schnittstellenports "10050" or "10071" haben. Sortieren Sie das Ergebnis nach dem Hostnamen in absteigender Reihenfolge und beschränke die Ausgabe auf 5 Hosts.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid", "host"],
        "selectInterfaces": ["port"],
        "filter": {
            "port": ["10050", "10071"]
        },
        "search": {
            "host": "*server*"
        },
        "searchWildcardsEnabled": true,
        "searchByAny": true,
        "sortfield": "host",
        "sortorder": "DESC",
        "limit": 5
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "50003",
            "host": "WebServer-Tomcat02",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        {
            "hostid": "50005",
            "host": "WebServer-Tomcat01",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        {
            "hostid": "50004",
            "host": "WebServer-Nginx",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        {
            "hostid": "99032",
            "host": "MySQL server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        },
        {
            "hostid": "99061",
            "host": "Linux server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        }
    ],
    "id": 1
}

Suche nach Hosts mit Wildcards und "preservekeys"

Wenn Sie der vorherigen Anfrage den Parameter "preservekeys" hinzufügen, wird das Ergebnis als assoziatives Array zurückgegeben, wobei die Schlüssel die IDs der Objekte sind.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid", "host"],
        "selectInterfaces": ["port"],
        "filter": {
            "port": ["10050", "10071"]
        },
        "search": {
            "host": "*server*"
        },
        "searchWildcardsEnabled": true,
        "searchByAny": true,
        "sortfield": "host",
        "sortorder": "DESC",
        "limit": 5,
        "preservekeys": true
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "50003": {
            "hostid": "50003",
            "host": "WebServer-Tomcat02",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        "50005": {
            "hostid": "50005",
            "host": "WebServer-Tomcat01",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        "50004": {
            "hostid": "50004",
            "host": "WebServer-Nginx",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        "99032": {
            "hostid": "99032",
            "host": "MySQL server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        },
        "99061": {
            "hostid": "99061",
            "host": "Linux server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        }
    },
    "id": 1
}