Table of Contents
item.get
Beschrijving
integer/array item.get(object parameters)
De methode maakt het mogelijk om items op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| itemids | string/array | Retourneer alleen items met de opgegeven ID's. |
| groupids | string/array | Retourneer alleen items die behoren tot de hosts van de gegeven groepen. |
| templateids | string/array | Retourneer alleen items die bij de opgegeven sjablonen horen. |
| hostids | string/array | Retourneer alleen items die bij de opgegeven hosts horen. |
| proxyids | string/array | Retourneer alleen items die worden gecontroleerd door de opgegeven proxy's. |
| interfaceids | string/array | Retourneer alleen items die de opgegeven hostinterfaces gebruiken. |
| graphids | string/array | Retourneer alleen items die in de gegeven grafieken worden gebruikt. |
| triggerids | string/array | Retourneer alleen items die in de gegeven triggers worden gebruikt. |
| webitems | flag | Webitems opnemen in het resultaat. |
| inherited | boolean | Indien ingesteld op true worden alleen items geretourneerd die zijn overgenomen van een sjabloon. |
| template | boolean | Indien ingesteld op true, worden alleen items geretourneerd die bij sjablonen horen. |
| monitored | boolean | Indien ingesteld op true retourneer alleen geactiveerde items die behoren tot gecontroleerde hosts. |
| group | string | Retourneer alleen items die behoren tot een groep met de opgegeven naam. |
| host | string | Retourneer alleen items die behoren tot een host met de opgegeven naam. |
| evaltype | integer | Regels voor het zoeken naar tags. Mogelijke waarden: 0 - (standaard) And/Or; 2 - Or. |
| tags | array van objecten | Retourneer alleen items met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelig of hoofdletterongevoelig zoeken op tagwaarde, afhankelijk van de operatorwaarde. Formaat: [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].Een lege array retourneert alle items. Mogelijke typen operatoren: 0 - (standaard) Like; 1 - Gelijk; 2 - Niet zoals; 3 - Niet gelijk 4 - Bestaat; 5 - Bestaat niet. |
| with_triggers | boolean | Indien ingesteld op true worden alleen items geretourneerd die in triggers worden gebruikt. |
| selectHosts | query | Retourneer een eigenschap hosts met een array van hosts waartoe het item behoort. |
| selectInterfaces | query | Retourneer een eigenschap interfaces met een array van hostinterfaces die door het item worden gebruikt. |
| selectTriggers | query | Retourneer een eigenschap triggers met de triggers waarin het item wordt gebruikt. Ondersteunt count. |
| selectGraphs | query | Retourneer een eigenschap graphs met de grafieken die het item bevatten. Ondersteunt count. |
| selectDiscoveryRule | query | Retourneer een eigenschap discoveryRule met de LLD-regel die het item heeft gemaakt. |
| selectItemDiscovery | query | Retourneer een eigenschap itemDiscovery met het item discovery-object. Het item discovery-object koppelt het item aan een item-prototype waaruit het is gemaakt.Het heeft de volgende eigenschappen: itemdiscoveryid - (string) ID van de item discovery;itemid - (string) ID van het gevonden item;parent_itemid - (string) ID van het prototype van het item waaruit het item is gemaakt;key_ - (string ) sleutel van het item prototype;lastcheck - (timestamp) tijd waarop het item voor het laatst werd ontdekt;ts_delete - (timestamp) tijd wanneer een item dat niet langer wordt ontdekt worden verwijderd. |
| selectPreprocessing | query | Retourneer een eigenschap preprocessing met opties voor voorbewerking van items. Het heeft de volgende eigenschappen: type - (string) Het type voorbewerkingsoptie:1 - Aangepaste vermenigvuldiger; 2 - Rechts bijsnijden; 3 - Links bijsnijden; 4 - Bijsnijden; 5 - Overeenkomstige reguliere expressies;< br>6 - Booleaans tot decimaal; 7 - Octaal tot decimaal; 8 - Hexadecimaal tot decimaal; 9 - Eenvoudige wijziging; 10 - Wijziging per seconde; 11 - XML XPath ; 12 - JSONPath; 13 - Binnen bereik; 14 - Komt overeen met reguliere expressie; 15 - Komt niet overeen met reguliere expressie; 16 - Controleer op fouten in JSON; 17 - Controleer op fouten in XML; 18 - Controleer op fouten met behulp van reguliere expressie; 19 - Negeer ongewijzigd; 20 - Verwijder ongewijzigd met hartslag; 21 - JavaScript; 22 - Prometheus-patroon; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervang; 26 - Controleer op niet-ondersteunde waarde; 27 - XML naar JSON.<br > params - (st ring) Extra parameters gebruikt door voorbewerkingsoptie. Meerdere parameters worden gescheiden door LF (\n)karakter.error_handler - (string) Actietype dat wordt gebruikt in geval van een mislukte voorverwerkingsstap:0 - Foutbericht wordt ingesteld door Zabbix-server;<br >1 - Waarde negeren; 2 - Aangepaste waarde instellen; 3 - Aangepaste foutmelding instellen. error_handler_params - (string) Parameters voor fouthandler. |
| selectTags | query | Retourneer de item-tags in de eigenschap tags. |
| selectValueMap | query | Retourneer een valuemap eigenschap met item value map. |
| filter | object | Retourneert alleen de resultaten die exact overeenkomen met het opgegeven filter. Accepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden een enkele waarde zijn of een array van waarden om mee te vergelijken. Ondersteunt extra filters: host - technische naam van de host waartoe het item behoort. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. Van toepassing op de volgende subselecties: selectGraphs - resultaten worden gesorteerd op name;selectTriggers - resultaten wordt gesorteerd op beschrijving. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: itemid, name, key_, delay, history, trends, type en status. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven op de pagina referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Items vinden via de key
Haal alle items van de host met ID "10084" op die het woord "system" in de items key hebben en sorteer deze bij naam
Verzoek:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"search": {
"key_": "system"
},
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23298",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Context switches per second",
"key_": "system.cpu.switches",
"delay": "1m",
"history": "7d",
"trends": "365d",
"lastvalue": "2552",
"lastclock": "1351090998",
"prevvalue": "2641",
"state": "0",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "sps",
"error": "",
"logtimefmt": "",
"templateid": "22680",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"lastns": "564054253",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "0s",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"parameters": []
},
{
"itemid": "23299",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU $2 time",
"key_": "system.cpu.util[,idle]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"lastvalue": "86.031879",
"lastclock": "1351090999",
"prevvalue": "85.306944",
"state": "0",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"error": "",
"logtimefmt": "",
"templateid": "17354",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"lastns": "564256864",
"flags": "0",
"interfaceid": "1",
"description": "The time the CPU has spent doing nothing.",
"inventory_link": "0",
"lifetime": "0s",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"parameters": []
},
{
"itemid": "23300",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU $2 time",
"key_": "system.cpu.util[,interrupt]",
"history": "7d",
"trends": "365d",
"lastvalue": "0.008389",
"lastclock": "1351091000",
"prevvalue": "0.000000",
"state": "0",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"error": "",
"logtimefmt": "",
"templateid": "22671",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"lastns": "564661387",
"flags": "0",
"interfaceid": "1",
"description": "The amount of time the CPU has been servicing hardware interrupts.",
"inventory_link": "0",
"lifetime": "0s",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"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",
"parameters": []
}
],
"id": 1
}Afhankelijke items zoeken op sleutel
Haal alle afhankelijke items op van host met ID "10116" die het woord "apache" in de sleutel hebben.
Verzoek:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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": "3s",
"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"
},
{
"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": "3s",
"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"
}
],
"id": 1
}HTTP-agentitem zoeken
Zoek HTTP-agentitem met post-body-type XML voor specifieke host-ID.
Verzoek:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 3,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Antwoord:
{
"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": "3s",
"url": "localhost",
"query_fields": [
{
"mode": "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": ""
}
],
"id": 3
}Items ophalen met voorverwerkingsregels
Haal alle items en hun voorverwerkingsregels op voor een specifieke host-ID.
Verzoek:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"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
}Zie ook
Bron
CItem::get() in ui/include/classes/api/services/CItem.php.