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 Typ Beschreibung
graphids ID/array Nur Graphen mit den angegebenen IDs zurückgeben.
groupids ID/array Nur Graphen zurückgeben, die zu Hosts oder Vorlagen in den angegebenen Hostgruppen oder Vorlagengruppen gehören.
templateids ID/array Nur Graphen zurückgeben, die zu den angegebenen Vorlagen gehören.
hostids ID/array Nur Graphen zurückgeben, die zu den angegebenen Hosts gehören.
itemids ID/array Nur Graphen zurückgeben, die die angegebenen Datenpunkte enthalten.
templated boolean Wenn auf true gesetzt, nur Graphen zurückgeben, die zu Vorlagen gehören.
inherited boolean Wenn auf true gesetzt, nur von einer Vorlage geerbte Graphen zurückgeben.
expandName flag Makros im Graphnamen erweitern.
selectHostGroups query Eine Eigenschaft hostgroups mit den Hostgruppen zurückgeben, zu denen der Graph gehört.
selectTemplateGroups query Eine Eigenschaft templategroups mit den Vorlagengruppen zurückgeben, zu denen der Graph gehört.
selectTemplates query Eine Eigenschaft templates mit den Vorlagen zurückgeben, zu denen der Graph gehört.
selectHosts query Eine Eigenschaft hosts mit den Hosts zurückgeben, zu denen der Graph gehört.
selectItems query Eine Eigenschaft items mit den im Graphen verwendeten Datenpunkten zurückgeben.
selectGraphDiscovery query Eine Eigenschaft graphDiscovery mit dem Graph-Discovery-Objekt zurückgeben. Das Graph-Discovery-Objekt verknüpft den Graphen mit einem Graph-Prototyp, aus dem er erstellt wurde.

Es hat die folgenden Eigenschaften:
graphid - (ID) ID des Graphen;
parent_graphid - (ID) ID des Graph-Prototyps, aus dem der Graph erstellt wurde;
lastcheck - (timestamp) Zeitpunkt, zu dem der Graph zuletzt entdeckt wurde;
status - (int) Status der Graph-Discovery:
0 - (Standard) Graph wurde entdeckt,
1 - Graph wird nicht mehr entdeckt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Graph gelöscht wird.
selectGraphItems query Eine Eigenschaft gitems mit den im Graphen verwendeten Datenpunkten zurückgeben.
selectDiscoveryRule query Eine Eigenschaft discoveryRule mit der Low-Level-Discovery-Regel zurückgeben, die den Graphen erstellt hat.
filter object Nur Ergebnisse zurückgeben, die genau 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 verglichen werden soll.

Unterstützt keine Eigenschaften vom Datentyp text.

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 Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: graphid, name, graphtype.
countOutput boolean Diese Parameter werden in der Referenzbeschreibung erläutert.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Dieser Parameter ist veraltet, bitte stattdessen selectHostGroups oder selectTemplateGroups verwenden.
Eine Eigenschaft groups mit den Hostgruppen und Vorlagengruppen zurückgeben, zu denen der Graph gehört.

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.