On this page
datenpunkt.get
Beschreibung
integer/array item.get(object parameters)
Die Methode ermöglicht das Abrufen von Datenpunkten anhand der angegebenen Parameter.
Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufruf der Methode kann in den Einstellungen der Benutzerrolle widerrufen 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 |
|---|---|---|
| itemids | ID/array | Nur Datenpunkte mit den angegebenen IDs zurückgeben. |
| groupids | ID/array | Nur Datenpunkte zurückgeben, die zu den Hosts aus den angegebenen Gruppen gehören. |
| templateids | ID/array | Nur Datenpunkte zurückgeben, die zu den angegebenen Vorlagen gehören. |
| hostids | ID/array | Nur Datenpunkte zurückgeben, die zu den angegebenen Hosts gehören. |
| proxyids | ID/array | Nur Datenpunkte zurückgeben, die von den angegebenen Proxys überwacht werden. |
| interfaceids | ID/array | Nur Datenpunkte zurückgeben, die die angegebenen Host-Schnittstellen verwenden. |
| graphids | ID/array | Nur Datenpunkte zurückgeben, die in den angegebenen Diagrammen verwendet werden. |
| triggerids | ID/array | Nur Datenpunkte zurückgeben, die in den angegebenen Auslösern verwendet werden. |
| webitems | flag | Web-Datenpunkte in das Ergebnis aufnehmen. |
| inherited | boolean | Wenn auf true gesetzt, nur von einer Vorlage geerbte Datenpunkte zurückgeben. |
| templated | boolean | Wenn auf true gesetzt, nur Datenpunkte zurückgeben, die zu Vorlagen gehören. |
| monitored | boolean | Wenn auf true gesetzt, nur aktivierte Datenpunkte zurückgeben, die zu überwachten Hosts gehören. |
| group | string | Nur Datenpunkte zurückgeben, die zu einer Gruppe mit dem angegebenen Namen gehören. |
| host | string | Nur Datenpunkte zurückgeben, die zu einem Host mit dem angegebenen Namen gehören. |
| evaltype | integer | Tag-Auswertungsmethode. Mögliche Werte: 0 - (Standard) Und/Oder; 2 - Oder. |
| tags | array | Nur Datenpunkte mit den angegebenen Tags zurückgeben. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Ein leeres Array gibt alle Datenpunkte zurück. Mögliche Operator-Werte: 0 - (Standard) Enthält; 1 - Entspricht; 2 - Enthält nicht; 3 - Entspricht nicht; 4 - Existiert; 5 - Existiert nicht. |
| with_triggers | boolean | Wenn auf true gesetzt, nur Datenpunkte zurückgeben, die in Auslösern verwendet werden. |
| selectHosts | query | Eine Eigenschaft hosts mit einem Array von Hosts zurückgeben, zu denen der Datenpunkt gehört. |
| selectInterfaces | query | Eine Eigenschaft interfaces mit einem Array von Host-Schnittstellen zurückgeben, die vom Datenpunkt verwendet werden. |
| selectTriggers | query | Eine Eigenschaft triggers mit den Auslösern zurückgeben, in denen der Datenpunkt verwendet wird.Unterstützt count. |
| selectGraphs | query | Eine Eigenschaft graphs mit den Diagrammen zurückgeben, die den Datenpunkt enthalten.Unterstützt count. |
| selectDiscoveryData | query | Eine Eigenschaft discoveryData mit den Daten des Datenpunkt-Discovery-Objekts zurückgeben. Das Datenpunkt-Discovery-Objekt verknüpft einen entdeckten Datenpunkt mit einem Datenpunkt-Prototyp, aus dem er entdeckt wurde.Es hat die folgenden Eigenschaften: parent_itemid - (string) ID des Datenpunkt-Prototyps, aus dem der Datenpunkt erstellt wurde;key_ - (string) Schlüssel des Datenpunkt-Prototyps;status - (int) Status der Datenpunkt-Discovery:0 - (Standard) Datenpunkt ist entdeckt, 1 - Datenpunkt wird nicht mehr entdeckt; ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Datenpunkt gelöscht wird;ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Datenpunkt deaktiviert wird;disable_source - (int) Kennzeichnung, ob der Datenpunkt 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 LLD-Regel zurückgeben, die den Datenpunkt erstellt hat. |
| selectPreprocessing | query | Eine Eigenschaft preprocessing mit den Vorverarbeitungsoptionen des Datenpunkts zurückgeben. |
| selectTags | query | Die Tags des Datenpunkts in der Eigenschaft tags zurückgeben. |
| selectValueMap | query | Eine Eigenschaft valuemap mit der Wertzuordnung des Datenpunkts 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 Datenpunkt gehört. |
| limitSelects | integer | Begrenzt die Anzahl der von Unterauswahlen zurückgegebenen Datensätze. Gilt für die folgenden Unterauswahlen: 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, history, trends, type, status. |
| countOutput | boolean | Diese Parameter werden in der Referenzbeschreibung beschrieben. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectItemDiscovery | query | Eine Eigenschaft itemDiscovery mit dem Datenpunkt-Discovery-Objekt zurückgeben. Das Datenpunkt-Discovery-Objekt verknüpft den Datenpunkt mit einem Datenpunkt-Prototyp, aus dem er erstellt wurde.Diese Abfrage ist veraltet; verwenden Sie stattdessen selectDiscoveryData. |
Rückgabewerte
(integer/array) Gibt entweder zurück:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter
countOutputverwendet wurde.
Beispiele
Finden von Datenpunkten nach Schlüssel
Rufen Sie alle Datenpunkte ab, die in Auslösern für eine bestimmte Host-ID verwendet werden und das Wort "system.cpu" im Datenpunktschlüssel enthalten, und sortieren Sie die Ergebnisse nach Name.
{
"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-Auslastung",
"key_": "system.cpu.util",
"delay": "0",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"logtimefmt": "",
"templateid": "42267",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "CPU-Auslastung in %.",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "CPU-Auslastung"
},
{
"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": "",
"logtimefmt": "",
"templateid": "42219",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Load average (15m avg)"
},
{
"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": "",
"logtimefmt": "",
"templateid": "42209",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Load average (1m avg)"
},
{
"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": "",
"logtimefmt": "",
"templateid": "42217",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Load average (5m avg)"
},
{
"itemid": "42260",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Anzahl der CPUs",
"key_": "system.cpu.num",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42220",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Anzahl der CPUs"
}
],
"id": 1
}Abhängige Datenpunkte nach Schlüssel finden
Rufen Sie alle abhängigen Datenpunkte von 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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Days"
},
{
"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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"name_resolved": "Hours"
}
],
"id": 1
}HTTP-Agent-Datenpunkt finden
HTTP-Agent-Datenpunkt mit Post-Body-Typ XML für eine bestimmte Host-ID finden.
{
"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": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"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": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "",
"prevvalue": "",
"name_resolved": "template item"
}
],
"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.