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 Graph-Prototypen zurück, die zu den angegebenen Discovery-Regeln gehören.
graphids ID/array Gibt nur Graph-Prototypen mit den angegebenen IDs zurück.
groupids ID/array Gibt nur Graph-Prototypen zurück, die zu Hosts oder Vorlagen in den angegebenen Host-Gruppen oder Vorlagen-Gruppen gehören.
hostids ID/array Gibt nur Graph-Prototypen zurück, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, werden nur von einer Vorlage geerbte Graph-Prototypen zurückgegeben.
itemids ID/array Gibt nur Graph-Prototypen zurück, die die angegebenen Datenpunkt-Prototypen enthalten.
templated boolean Wenn auf true gesetzt, werden nur Graph-Prototypen zurückgegeben, die zu Vorlagen gehören.
templateids ID/array Gibt nur Graph-Prototypen zurück, die zu den angegebenen Vorlagen gehören.
selectDiscoveryData query Gibt eine discoveryData-Eigenschaft mit den Discovery-Objektdaten des Graph-Prototyps zurück. Das Discovery-Objekt des Graph-Prototyps verknüpft einen entdeckten Graph-Prototyp mit einem Graph-Prototyp, aus dem er entdeckt wurde.

Es hat die folgenden Eigenschaften:
parent_graphid - (ID) ID des Graph-Prototyps, aus dem der Graph erstellt wurde;
status - (int) Status der Graph-Discovery:
0 - (Standard) Graph-Prototyp ist entdeckt,
1 - Graph-Prototyp ist nicht mehr entdeckt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein Graph-Prototyp, der nicht mehr entdeckt wird, gelöscht wird.
selectDiscoveryRule query Gibt eine Eigenschaft discoveryRule mit der LLD-Regel zurück, zu der der Graph-Prototyp gehört.
selectDiscoveryRulePrototype query Gibt eine Eigenschaft discoveryRulePrototype mit dem übergeordneten LLD-Regelprototyp zurück, zu dem der Graph-Prototyp gehört.
selectGraphItems query Gibt eine Eigenschaft gitems mit den im Graph-Prototyp verwendeten Graph-Elementen zurück.
selectHostGroups query Gibt eine Eigenschaft hostgroups mit den Host-Gruppen zurück, zu denen der Graph-Prototyp gehört.
selectHosts query Gibt eine Eigenschaft hosts mit den Hosts zurück, zu denen der Graph-Prototyp gehört.
selectItems query Gibt eine items-Eigenschaft mit den im Graph-Prototyp verwendeten Datenpunkten und Datenpunkt-Prototypen zurück.
selectTemplateGroups query Gibt eine Eigenschaft templategroups mit den Vorlagen-Gruppen zurück, zu denen der Graph-Prototyp gehört.
selectTemplates query Gibt eine Eigenschaft templates mit den Vorlagen zurück, zu denen der Graph-Prototyp gehört.
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 werden soll.

Unterstützt keine Eigenschaften des text-Datentyps.

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

Mögliche Werte: graphid, name, graphtype, discovered.
countOutput boolean Diese Parameter sind im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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 Graphprototypen aus einer LLD-Regel

Rufen Sie alle Graphprototypen 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": "Speicherplatzbelegung {#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",
            "flags": "2"
            "discover": "0"
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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