graphprototype.get

Beschreibung

integer/array graphprototype.get(object parameters)

Mit dieser Methode können Graph-Prototypen 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
discoveryids ID/array Gibt nur Diagrammprototypen zurück, die zu den angegebenen Erkennungsregeln gehören.
graphids ID/array Gibt nur Diagrammprototypen mit den angegebenen IDs zurück.
groupids ID/array Gibt nur Diagrammprototypen zurück, die zu Hosts oder Vorlagen in den angegebenen Hostgruppen oder Vorlagengruppen gehören.
hostids ID/array Gibt nur Diagrammprototypen zurück, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, werden nur von einer Vorlage geerbte Diagrammprototypen zurückgegeben.
itemids ID/array Gibt nur Diagrammprototypen zurück, die die angegebenen Item-Prototypen enthalten.
templated boolean Wenn auf true gesetzt, werden nur Diagrammprototypen zurückgegeben, die zu Vorlagen gehören.
templateids ID/array Gibt nur Diagrammprototypen zurück, die zu den angegebenen Vorlagen gehören.
selectDiscoveryRule query Gibt eine Eigenschaft discoveryRule mit der LLD-Regel zurück, zu der der Diagrammprototyp gehört.
selectGraphItems query Gibt eine Eigenschaft gitems mit den im Diagrammprototyp verwendeten Diagrammelementen zurück.
selectHostGroups query Gibt eine Eigenschaft hostgroups mit den Hostgruppen zurück, zu denen der Diagrammprototyp gehört.
selectHosts query Gibt eine Eigenschaft hosts mit den Hosts zurück, zu denen der Diagrammprototyp gehört.
selectItems query Gibt eine Eigenschaft items mit den Datenpunkten und Item-Prototypen zurück, die im Diagrammprototyp verwendet werden.
selectTemplateGroups query Gibt eine Eigenschaft templategroups mit den Vorlagengruppen zurück, zu denen der Diagrammprototyp gehört.
selectTemplates query Gibt eine Eigenschaft templates mit den Vorlagen zurück, zu denen der Diagrammprototyp gehört.
filter object Gibt nur die Ergebnisse zurück, die genau dem angegebenen Filter entsprechen.

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

Unterstützt keine Eigenschaften vom Datentyp text.

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

Mögliche Werte: graphid, name, graphtype, discovered.
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 verwenden Sie stattdessen selectHostGroups oder selectTemplateGroups.
Gibt eine Eigenschaft groups mit den Hostgruppen und Vorlagengruppen zurück, zu denen der Diagrammprototyp 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 Graphvorlagen aus einer LLD-Regel

Rufen Sie alle Graphvorlagen aus einer LLD-Regel ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "graphprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "name": "Disk space usage {#FSNAME}",
            "width": "600",
            "height": "340",
            "yaxismin": "0.0000",
            "yaxismax": "0.0000",
            "templateid": "442",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "discover": "0"
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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