datenpunktprototyp.get

Beschreibung

integer/array itemprototype.get(object parameters)

Mit dieser Methode können Datenpunkt-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 Typ Beschreibung
discoveryids ID/array Nur Item-Prototypen zurückgeben, die zu den angegebenen LLD-Regeln gehören.
graphids ID/array Nur Item-Prototypen zurückgeben, die in den angegebenen Graph-Prototypen verwendet werden.
hostids ID/array Nur Item-Prototypen zurückgeben, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, nur von einer Vorlage geerbte Item-Prototypen zurückgeben.
itemids ID/array Nur Item-Prototypen mit den angegebenen IDs zurückgeben.
monitored boolean Wenn auf true gesetzt, nur aktivierte Item-Prototypen zurückgeben, die zu überwachten Hosts gehören.
templated boolean Wenn auf true gesetzt, nur Item-Prototypen zurückgeben, die zu Vorlagen gehören.
templateids ID/array Nur Item-Prototypen zurückgeben, die zu den angegebenen Vorlagen gehören.
triggerids ID/array Nur Item-Prototypen zurückgeben, die in den angegebenen Auslöser-Prototypen verwendet werden.
selectDiscoveryData query Eine Eigenschaft discoveryData mit den Daten des Discovery-Objekts des Item-Prototyps zurückgeben. Das Discovery-Objekt des Item-Prototyps verknüpft einen entdeckten Item-Prototyp mit einem Item-Prototyp, aus dem er entdeckt wurde.

Es hat die folgenden Eigenschaften:
parent_itemid - (string) ID des Item-Prototyps, aus dem der Item-Prototyp erstellt wurde;
key_ - (string) Schlüssel des Item-Prototyps;
status - (int) Status der Discovery des Item-Prototyps:
0 - (Standard) Item-Prototyp ist entdeckt,
1 - Item-Prototyp ist nicht mehr entdeckt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Item-Prototyp gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Item-Prototyp deaktiviert wird;
disable_source - (int) Kennzeichnung, ob der Item-Prototyp durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Eine Eigenschaft discoveryRule mit der Low-Level-Discovery-Regel zurückgeben, zu der der Item-Prototyp gehört.
selectDiscoveryRulePrototype query Eine Eigenschaft discoveryRulePrototype mit dem übergeordneten LLD-Regel-Prototyp zurückgeben, zu dem der Item-Prototyp gehört.
selectGraphs query Eine Eigenschaft graphs mit Graph-Prototypen zurückgeben, in denen der Item-Prototyp verwendet wird.

count wird unterstützt.
selectHosts query Eine Eigenschaft hosts mit einem Array von Hosts zurückgeben, zu denen der Item-Prototyp gehört.
selectTags query Die Tags des Item-Prototyps in der Eigenschaft tags zurückgeben.
selectTriggers query Eine Eigenschaft triggers mit Auslöser-Prototypen zurückgeben, in denen der Item-Prototyp verwendet wird.

count wird unterstützt.
selectPreprocessing query Eine Eigenschaft preprocessing mit den Vorverarbeitungsoptionen des Item-Prototyps zurückgeben.
selectValueMap query Eine Eigenschaft valuemap mit der Wertzuordnung des Item-Prototyps zurückgeben.
filter object Nur Ergebnisse zurückgeben, 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 verglichen werden soll.

Unterstützt keine Eigenschaften vom Datentyp text.

Unterstützt zusätzliche Eigenschaften:
host - technischer Name des Hosts, zu dem der Item-Prototyp gehört.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen:
selectGraphs - Ergebnisse werden nach name sortiert;
selectTriggers - Ergebnisse werden nach description sortiert.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: itemid, name, key_, delay, type, status, history, trends, discovered.
countOutput boolean Diese Parameter werden in den Referenzkommentaren 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 Datenpunkt-Prototypen aus einer LLD-Regel

Rufen Sie alle Datenpunkt-Prototypen für eine bestimmte LLD-Regel-ID ab.

Anfrage:

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

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23077",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10079",
            "name": "Incoming network traffic on en0",
            "key_": "net.if.in[en0]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "bps",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "parameters": []
        },
        {
            "itemid": "10010",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10001",
            "name": "Prozessorlast (1-Minuten-Durchschnitt pro Kern)",
            "key_": "system.cpu.load[percpu,avg1]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "units": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "Die Prozessorlast wird als System-CPU-Last geteilt durch die Anzahl der CPU-Kerne berechnet.",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "parameters": []
        }
    ],
    "id": 1
}

Abhängigen Datenpunkt finden

Finden Sie einen abhängigen Datenpunkt für eine bestimmte Datenpunkt-ID.

Request:

{
    "jsonrpc": "2.0",
    "method": "item.get",
    "params": {
        "output": "extend",
        "filter": {
            "type": 18,
            "master_itemid": "25545"
        },
        "limit": "1"
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "25547",
            "type": "18",
            "snmp_oid": "",
            "hostid": "10116",
            "name": "Seconds",
            "key_": "apache.status.uptime.seconds",
            "delay": "0",
            "history": "90d",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "0",
            "interfaceid": "0",
            "description": "",
            "evaltype": "0",
            "master_itemid": "25545",
            "jmx_endpoint": "",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "parameters": []
        }
    ],
    "id": 1
}

HTTP-Agent-Vorlagen-Datenpunkt finden

HTTP-Agent-Vorlagen-Datenpunkt mit der Anfragemethode HEAD für eine bestimmte Host-ID finden.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "hostids": "10254",
        "filter": {
            "type": 19,
            "request_method": 3
        }
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "28257",
            "type": "19",
            "snmp_oid": "",
            "hostid": "10254",
            "name": "discovered",
            "key_": "item[{#INAME}]",
            "delay": "{#IUPDATE}",
            "history": "90d",
            "trends": "30d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "2",
            "description": "",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "{#IURL}",
            "query_fields": [],
            "posts": "",
            "status_codes": "",
            "follow_redirects": "0",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "3",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "parameters": []
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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