graph.get

Beschreibung

integer/array graph.get(object parameters)

Mit dieser Methode können Graphen entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
graphids ID/array Gibt nur Graphen mit den angegebenen IDs zurück.
groupids ID/array Gibt nur Graphen zurück, die zu Hosts oder Vorlagen in den angegebenen Host-Gruppen oder Vorlagen-Gruppen gehören.
templateids ID/array Gibt nur Graphen zurück, die zu den angegebenen Vorlagen gehören.
hostids ID/array Gibt nur Graphen zurück, die zu den angegebenen Hosts gehören.
itemids ID/array Gibt nur Graphen zurück, die die angegebenen Datenpunkte enthalten.
templated boolean Wenn auf true gesetzt, werden nur Graphen zurückgegeben, die zu Vorlagen gehören.
inherited boolean Wenn auf true gesetzt, werden nur Graphen zurückgegeben, die von einer Vorlage geerbt wurden.
expandName flag Erweitert Makros im Graphnamen.
selectDiscoveryData query Gibt eine discoveryData-Eigenschaft mit den Daten des Graph-Discovery-Objekts zurück. Das Graph-Discovery-Objekt verknüpft einen entdeckten Graphen mit einem Graphprototyp, aus dem er entdeckt wurde.

Es hat die folgenden Eigenschaften:
parent_graphid - (ID) ID des Graphprototyps, aus dem der Graph erstellt wurde;
status - (int) Status der Graph-Discovery:
0 - (Standard) Graph ist entdeckt,
1 - Graph ist nicht mehr entdeckt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein Graph, der nicht mehr entdeckt wird, gelöscht wird.
selectDiscoveryRule query Gibt eine discoveryRule-Eigenschaft mit der Low-Level-Discovery-Regel zurück, die den Graphen erstellt hat.
selectHostGroups query Gibt eine hostgroups-Eigenschaft mit den Host-Gruppen zurück, zu denen der Graph gehört.
selectTemplateGroups query Gibt eine templategroups-Eigenschaft mit den Vorlagen-Gruppen zurück, zu denen der Graph gehört.
selectTemplates query Gibt eine templates-Eigenschaft mit den Vorlagen zurück, zu denen der Graph gehört.
selectHosts query Gibt eine hosts-Eigenschaft mit den Hosts zurück, zu denen der Graph gehört.
selectItems query Gibt eine items-Eigenschaft mit den im Graphen verwendeten Datenpunkten zurück.
selectGraphItems query Gibt eine gitems-Eigenschaft mit den im Graphen verwendeten Datenpunkten zurück.
filter object Gibt nur die Ergebnisse zurück, die exakt dem angegebenen Filter entsprechen.

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen wird.

Unterstützt keine Eigenschaften des text-Datentyps.

Unterstützt zusätzliche Eigenschaften:
host - technischer Name des Hosts, zu dem der Graph gehört;
hostid - ID des Hosts, zu dem der Graph gehört.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: graphid, name, graphtype.
countOutput boolean Diese Parameter sind in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGraphDiscovery query Gibt eine graphDiscovery-Eigenschaft mit dem Graph-Discovery-Objekt zurück. Die Graph-Discovery-Objekte verknüpfen den Graphen mit einem Graphprototyp, aus dem er erstellt wurde.

Diese Abfrage ist veraltet, bitte verwenden Sie stattdessen selectDiscoveryData.

Rückgabewerte

(integer/array) Kann die folgenden Dinge zurück geben:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen von Diagrammen von Hosts

Rufen Sie alle Diagramme vom Host „10107“ ab und sortieren Sie sie nach Namen.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "graph.get",
    "params": {
        "output": "extend",
        "hostids": 10107,
        "sortfield": "name"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "612",
            "name": "CPU jumps",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "613",
            "name": "CPU load",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "614",
            "name": "CPU utilization",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "1",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "645",
            "name": "Disk space usage /",
            "width": "600",
            "height": "340",
            "yaxismin": "0",
            "yaxismax": "0",
            "templateid": "0",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "4"
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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