Documentation
Table of Contents
item.get
Beschrijving
integer/array item.get(object parameters)
Deze methode maakt het mogelijk om items op te halen op basis van de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Omschrijving |
|---|---|---|
| itemids | string/array | Geef alleen items terug met de opgegeven ID's. |
| groupids | string/array | Geef alleen items terug die behoren tot de hosts van de opgegeven groepen. |
| templateids | string/array | Geef alleen items terug die behoren tot de opgegeven templates. |
| hostids | string/array | Geef alleen items terug die behoren tot de opgegeven hosts. |
| proxyids | string/array | Geef alleen items terug die worden gemonitord door de opgegeven proxies. |
| interfaceids | string/array | Geef alleen items terug die de opgegeven hostinterfaces gebruiken. |
| graphids | string/array | Geef alleen items terug die worden gebruikt in de opgegeven grafieken. |
| triggerids | string/array | Geef alleen items terug die worden gebruikt in de opgegeven triggers. |
| webitems | flag | Neem webitems op in het resultaat. |
| inherited | boolean | Indien ingesteld op true, geef alleen items terug die geërfd zijn van een template. |
| templated | boolean | Indien ingesteld op true, geef alleen items terug die behoren tot templates. |
| monitored | boolean | Indien ingesteld op true, geef alleen ingeschakelde items terug die behoren tot gemonitorde hosts. |
| group | string | Geef alleen items terug die behoren tot een groep met de opgegeven naam. |
| host | string | Geef alleen items terug die behoren tot een host met de opgegeven naam. |
| evaltype | integer | Regels voor tag-zoeken. Mogelijke waarden: 0 - (standaard) And/Or; 2 - Of. |
| tags | array van objecten | Geef alleen items terug met de opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tagwaarde, afhankelijk van de operatorwaarde. Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Een lege array geeft alle items terug. Mogelijke operator types: 0 - (standaard) Like; 1 - Gelijk aan; 2 - Niet als; 3 - Niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet. |
| with_triggers | boolean | Indien ingesteld op true, geef alleen items terug die worden gebruikt in triggers. |
| selectHosts | query | Geef een hosts eigenschap terug met een array van hosts waartoe het item behoort. |
| selectInterfaces | query | Geef een interfaces eigenschap terug met een array van hostinterfaces die door het item worden gebruikt. |
| selectTriggers | query | Geef een triggers eigenschap terug met de triggers waarin het item wordt gebruikt.Ondersteunt count. |
| selectGraphs | query | Geef een graphs eigenschap terug met de grafieken die het item bevatten.Ondersteunt count. |
| selectDiscoveryRule | query | Geef een discoveryRule eigenschap terug met de LLD-regel die het item heeft gemaakt. |
| selectItemDiscovery | query | Geef een itemDiscovery eigenschap terug met het item ontdekkingsobject. Het item ontdekkingsobject koppelt het item aan een itemprototype waaruit het is gemaakt.Heeft de volgende eigenschappen: itemdiscoveryid - (string) ID van de item ontdekking;itemid - (string) ID van het ontdekte item;parent_itemid - (string) ID van het itemprototype waaruit het item is gemaakt;key_ - (string) sleutel van het itemprototype;lastcheck - (timestamp) tijd waarop het item voor het laatst is ontdekt;ts_delete - (timestamp) tijd waarop een item dat niet langer wordt ontdekt, zal worden verwijderd. |
| selectPreprocessing | query | Geef een preprocessing eigenschap terug met item voorverwerkingsopties.Heeft de volgende eigenschappen: type - (string) Het type voorverwerkingsoptie:1 - Aangepaste vermenigvuldiger; 2 - Rechts trimmen; 3 - Links trimmen; 4 - Trimmen; 5 - Overeenkomst met reguliere expressie; 6 - Booleaan naar decimaal; 7 - Octaal naar decimaal; 8 - Hexadecimaal naar decimaal; 9 - Eenvoudige verandering; 10 - Verandering per seconde; 11 - XML XPath; 12 - JSONPath; 13 - In bereik; 14 - Overeenkomst met reguliere expressie; 15 - Niet overeenkomend met reguliere expressie; 16 - Controleren op fout in JSON; 17 - Controleren op fout in XML; 18 - Controleren op fout met reguliere expressie; 19 - Onveranderd negeren; 20 - Onveranderd negeren met heartbeat; 21 - JavaScript; 22 - Prometheus patroon; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervangen; 26 - Controleren op niet-ondersteunde waarde; 27 - XML naar JSON; 28 - SNMP loopwaarde; 29 - SNMP loop naar JSON. params - (string) Aanvullende parameters gebruikt door voorverwerkingsoptie. Meerdere parameters worden gescheiden door het nieuwe regelteken (\n).error_handler - (string) Actietype dat wordt gebruikt bij fout in voorverwerkingsstap:0 - Foutmelding wordt ingesteld door Zabbix server; 1 - Waarde negeren; 2 - Aangepaste waarde instellen; 3 - Aangepaste foutmelding instellen. error_handler_params - (string) Parameters voor foutafhandelaar. |
| selectTags | query | Geef de item tags terug in de tags eigenschap. |
| selectValueMap | query | Geef een valuemap eigenschap terug met item waardekaart. |
| filter | object | Geef alleen resultaten terug die exact overeenkomen met de opgegeven filter. <brAccepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde of een array van waarden zijn waartegen moet worden vergeleken. <brOndersteunt aanvullende filters: host - technische naam van de host waartoe het item behoort. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselects. <brGeldt voor de volgende subselects: selectGraphs - resultaten worden gesorteerd op name;selectTriggers - resultaten worden gesorteerd op description. |
| sortfield | string/array | Sorteer het resultaat op de opgegeven eigenschappen. <brMogelijke waarden: itemid, name, key_, delay, history, trends, type, status. |
| countOutput | boolean | Deze parameters die gemeenschappelijk zijn voor alle get methoden, worden in detail beschreven op de referentiecommentaar pagina. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Items zoeken op basis van sleutel
Haal alle items op die worden gebruikt in triggers voor een specifiek host-ID en die het woord "system.cpu" in de item-sleutel hebben, en sorteer de resultaten op naam.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"id": 1
}Reactie:
{
"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": "%",
"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",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "42264",
"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": "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": "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": "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": "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": "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": "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": "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": "",
"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": "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
}Afhankelijke items opzoeken op basis van sleutel
Haal alle afhankelijke items op van host met ID "10116" die het woord "apache" in de sleutel hebben.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Dagen",
"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": "Uren",
"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 vinden
Vind een HTTP-agentitem met postbodytype XML voor een specifiek host-ID.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "sjabloonitem",
"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": 1
}Items ophalen met voorbewerkingsregels
Haal alle items op en hun voorbewerkingsregels op voor een specifiek host-ID.
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": {
"itemid": "23865",
"name": "HTTP-agentvoorbeeld 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.