On this page
datenpunkt.get
Beschreibung
integer/array item.get(object parameters)
Mit dieser Methode können Datenpunkte 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 |
|---|---|---|
| itemids | ID/array | Gibt nur Datenpunkte mit den angegebenen IDs zurück. |
| groupids | ID/array | Gibt nur Datenpunkte zurück, die zu den Hosts aus den angegebenen Gruppen gehören. |
| templateids | ID/array | Gibt nur Datenpunkte zurück, die zu den angegebenen Vorlagen gehören. |
| hostids | ID/array | Gibt nur Datenpunkte zurück, die zu den angegebenen Hosts gehören. |
| proxyids | ID/array | Gibt nur Datenpunkte zurück, die von den angegebenen Proxys überwacht werden. |
| interfaceids | ID/array | Gibt nur Datenpunkte zurück, die die angegebenen Host-Schnittstellen verwenden. |
| graphids | ID/array | Gibt nur Datenpunkte zurück, die in den angegebenen Diagrammen verwendet werden. |
| triggerids | ID/array | Gibt nur Datenpunkte zurück, die in den angegebenen Auslösern verwendet werden. |
| webitems | flag | Schließt Web-Datenpunkte in das Ergebnis ein. |
| inherited | boolean | Wenn auf true gesetzt, werden nur Datenpunkte zurückgegeben, die von einer Vorlage geerbt wurden. |
| inheritedTags | boolean | Gibt Datenpunkte zurück, die die angegebenen tags auch in Host/Vorlage/verknüpften Vorlagen haben.Mögliche Werte: true - Vorlage/Host/verknüpfte Vorlagen müssen die angegebenen Tags ebenfalls haben;false - (Standard) Tags aus Vorlage/Host/verknüpften Vorlagen werden ignoriert. |
| templated | boolean | Wenn auf true gesetzt, werden nur Datenpunkte zurückgegeben, die zu Vorlagen gehören. |
| monitored | boolean | Wenn auf true gesetzt, werden nur aktivierte Datenpunkte zurückgegeben, die zu überwachten Hosts gehören. |
| group | string | Gibt nur Datenpunkte zurück, die zu einer Gruppe mit dem angegebenen Namen gehören. |
| host | string | Gibt nur Datenpunkte zurück, die zu einem Host mit dem angegebenen Namen gehören. |
| evaltype | integer | Auswertungsmethode für Tags. Mögliche Werte: 0 - (Standard) Und/Oder; 2 - Oder. |
| tags | array | Gibt nur Datenpunkte mit den angegebenen Tags zurück. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Ein leeres Array gibt alle Datenpunkte zurück. Mögliche Werte für operator: 0 - (Standard) Enthält; 1 - Gleich; 2 - Enthält nicht; 3 - Ungleich; 4 - Existiert; 5 - Existiert nicht. |
| with_triggers | boolean | Wenn auf true gesetzt, werden nur Datenpunkte zurückgegeben, die in Auslösern verwendet werden. |
| selectHosts | query | Gibt eine Eigenschaft hosts mit einem Array von Hosts zurück, zu denen der Datenpunkt gehört. |
| selectInterfaces | query | Gibt eine Eigenschaft interfaces mit einem Array von Host-Schnittstellen zurück, die vom Datenpunkt verwendet werden. |
| selectTriggers | query | Gibt eine Eigenschaft triggers mit den Auslösern zurück, in denen der Datenpunkt verwendet wird.Unterstützt count. |
| selectGraphs | query | Gibt eine Eigenschaft graphs mit den Diagrammen zurück, die den Datenpunkt enthalten.Unterstützt count. |
| selectDiscoveryData | query | Gibt eine Eigenschaft discoveryData mit den Objektdaten der Datenpunkterkennung zurück. Das Datenpunkterkennungsobjekt verknüpft einen erkannten Datenpunkt mit einem Datenpunktprototyp, aus dem er erkannt wurde.Es hat die folgenden Eigenschaften: parent_itemid - (string) ID des Datenpunktprototyps, aus dem der Datenpunkt erstellt wurde;key_ - (string) Schlüssel des Datenpunktprototyps;status - (int) Status der Datenpunkterkennung:0 - (Standard) Datenpunkt ist erkannt, 1 - Datenpunkt wird nicht mehr erkannt; ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Datenpunkt gelöscht wird;ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Datenpunkt deaktiviert wird;disable_source - (int) Kennzeichen, ob der Datenpunkt durch eine LLD-Regel oder manuell deaktiviert wurde:0 - (Standard) automatisch deaktiviert, 1 - durch eine LLD-Regel deaktiviert. |
| selectDiscoveryRule | query | Gibt eine Eigenschaft discoveryRule mit der LLD-Regel zurück, die den Datenpunkt erstellt hat. |
| selectInheritedTags | query | Gibt eine Eigenschaft inheritedTags mit Tags zurück, die sich auf Vorlage/Host/verknüpften Vorlagen befinden. |
| selectPreprocessing | query | Gibt eine Eigenschaft preprocessing mit Optionen für die Datenpunktvorverarbeitung zurück. |
| selectTags | query | Gibt die Datenpunkt-Tags in der Eigenschaft tags zurück. |
| selectValueMap | query | Gibt eine Eigenschaft valuemap mit der Wertezuordnung des Datenpunkts 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 verglichen werden soll. Unterstützt keine Eigenschaften vom Datentyp text.Unterstützt zusätzliche Eigenschaften: host - technischer Name des Hosts, zu dem der Datenpunkt 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 | Sortiert das Ergebnis nach den angegebenen Eigenschaften. Mögliche Werte: itemid, name, key_, delay, history, trends, type, status. |
| 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 | |
| selectItemDiscovery | query | Gibt eine Eigenschaft itemDiscovery mit dem Datenpunkterkennungsobjekt zurück. Das Datenpunkterkennungsobjekt verknüpft den Datenpunkt mit einem Datenpunktprototyp, aus dem er erstellt wurde.Diese Abfrage ist veraltet; bitte verwenden Sie stattdessen selectDiscoveryData. |
Rückgabewerte
(integer/array) Gibt entweder Folgendes zurück:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter
countOutputverwendet wurde.
Beispiele
Datenpunkte nach Schlüssel finden
Rufen Sie alle Datenpunkte ab, die in Auslösern für eine bestimmte Host-ID verwendet werden, deren Datenpunktschlüssel das Wort „system.cpu“ enthält, und sortieren Sie die Ergebnisse nach Namen.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "42269",
"type": "18",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU utilization",
"key_": "system.cpu.util",
"delay": "0",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"formula": "",
"logtimefmt": "",
"templateid": "42267",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "CPU utilization in %.",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "42264",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "CPU utilization",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42259",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (15m avg)",
"key_": "system.cpu.load[all,avg15]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42219",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Load average (15m avg)",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42249",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (1m avg)",
"key_": "system.cpu.load[all,avg1]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42209",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Load average (1m avg)",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42257",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (5m avg)",
"key_": "system.cpu.load[all,avg5]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42217",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Load average (5m avg)",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42260",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Number of CPUs",
"key_": "system.cpu.num",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42220",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Number of CPUs",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}Abhängige Datenpunkte nach Schlüssel finden
Rufen Sie alle abhängigen Datenpunkte vom Host mit der ID „10116“ ab, die das Wort „apache“ im Schlüssel enthalten.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Days",
"key_": "apache.status.uptime.days",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Days",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "25555",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Hours",
"key_": "apache.status.uptime.hours",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Hours",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}HTTP-Agent-Datenpunkt finden
Finden Sie einen HTTP-Agent-Datenpunkt mit dem Post-Body-Typ XML für eine bestimmte Host-ID.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "template item",
"key_": "ti",
"delay": "30s",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "",
"url": "localhost",
"query_fields": [
{
"name": "mode",
"value": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"http_proxy": "",
"headers": [],
"retrieve_mode": "1",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "template item",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "",
"prevvalue": ""
}
],
"id": 1
}Abrufen von Datenpunkten mit Vorverarbeitungsregeln
Rufen Sie alle Datenpunkte und ihre Vorverarbeitungsregeln für eine bestimmte Host-ID ab.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": {
"itemid": "23865",
"name": "HTTP agent example JSON",
"key_": "json",
"preprocessing": [
{
"type": "12",
"params": "$.random",
"error_handler": "1",
"error_handler_params": ""
}
]
},
"id": 1
}Siehe auch
Quelle
CItem::get() in ui/include/classes/api/services/CItem.php.