Auf dieser Seite
datenpunkt.get
Beschreibung
integer/array item.get(object parameters)
Die Methode ermöglicht es Ihnen, Datenpunkte anhand der angegebenen Parameter abzurufen.
Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.
Parameter
(object) Parameter zur Definition der gewünschten Ausgabe.
Die Methode unterstützt die folgenden Parameter.
| Parameter | Typ | 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 Graphen 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 von einer Vorlage geerbte Datenpunkte zurückgegeben. |
| inheritedTags | boolean | Gibt Datenpunkte zurück, deren angegebene tags auch in Hosts/Vorlagen/verknüpften Vorlagen vorhanden sind.Mögliche Werte: true - Vorlagen/Hosts/verknüpfte Vorlagen müssen ebenfalls die angegebenen Tags besitzen;false - (Standard) Tags aus Vorlagen/Hosts/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 | Tag-Auswertungsmethode. 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 Operatoren: 0 - (Standard) Enthält; 1 - Ist gleich; 2 - Enthält nicht; 3 - Ist nicht gleich; 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 hosts-Eigenschaft mit einem Array der Hosts zurück, zu denen der Datenpunkt gehört. |
| selectInterfaces | query | Gibt eine interfaces-Eigenschaft mit einem Array der vom Datenpunkt verwendeten Host-Schnittstellen zurück. |
| selectTriggers | query | Gibt eine triggers-Eigenschaft mit den Auslösern zurück, in denen der Datenpunkt verwendet wird.Unterstützt count. |
| selectGraphs | query | Gibt eine graphs-Eigenschaft mit den Graphen zurück, die den Datenpunkt enthalten.Unterstützt count. |
| selectDiscoveryData | query | Gibt eine discoveryData-Eigenschaft mit den Daten des Datenermittlungsobjekts des Datenpunkts zurück. Das Datenermittlungsobjekt des Datenpunkts verknüpft einen ermittelten Datenpunkt mit einem Datenpunkt-Prototyp, aus dem er ermittelt wurde.Es besitzt 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) Datenermittlungsstatus des Datenpunkts:0 - (Standard) Datenpunkt wurde ermittelt, 1 - Datenpunkt wird nicht mehr ermittelt; ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr ermittelter Datenpunkt gelöscht wird;ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr ermittelter Datenpunkt deaktiviert wird;disable_source - (int) Gibt an, 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 discoveryRule-Eigenschaft mit der LLD-Regel zurück, durch die der Datenpunkt erstellt wurde. |
| selectInheritedTags | query | Gibt eine inheritedTags-Eigenschaft mit Tags zurück, die in Vorlagen/Hosts/verknüpften Vorlagen vorhanden sind. |
| selectPreprocessing | query | Gibt eine preprocessing-Eigenschaft mit den Vorverarbeitungsoptionen des Datenpunkts zurück. |
| selectTags | query | Gibt die Tags des Datenpunkts in der tags-Eigenschaft zurück. |
| selectValueMap | query | Gibt eine valuemap-Eigenschaft mit der Wertzuordnung des Datenpunkts zurück. |
| filter | object | Gibt nur Ergebnisse zurück, die exakt mit dem angegebenen Filter übereinstimmen. Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen werden soll. Unterstützt keine Eigenschaften des Datentyps 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 werden in der Referenzdokumentation 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 itemDiscovery-Eigenschaft mit dem Datenermittlungsobjekt des Datenpunkts zurück. Das Datenermittlungsobjekt 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 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.