Documentation
Table of Contents
item.get
Descripció
integer/array item.get(object parameters)
El mètode permet recuperar elements segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| itemids | string/array | Retorna només els elements amb els identificadors donats. |
| groupids | string/array | Retorna només els elements que pertanyen als equips dels grups donats. |
| templateids | string/array | Retorna només els elements que pertanyen a les plantilles donades. |
| hostids | string/array | Retorna només els elements que pertanyen als equips donats. |
| proxyids | string/array | Retorna només els elements monitorats pels proxys donats. |
| interfaceids | string/array | Retorna només elements que empren les interfícies d'equip donades. |
| graphids | string/array | Retorna només els elements emprats en els gràfics donats. |
| triggerids | string/array | Retorna només els elements emprats en els triggers donats. |
| webitems | flag | Inclou elements web al resultat. |
| inherited | boolean | Si s'estableix a true, només retorna els elements heretats d'un model. |
| template | boolean | Si s'estableix a true, retorna només els elements que pertanyen a les plantilles. |
| monitored | boolean | Si s'estableix a true, només retorna els elements activats que pertanyen als equips monitorats. |
| group | string | Retorna només els elements que pertanyen a un grup amb el nom especificat. |
| host | string | Retorna només els elements que pertanyen a un equip amb el nom especificat. |
| evaltype | integer | Regles de cerca d'etiquetes. Valors possibles: 0 - (per defecte) I/O; 2 - O. |
| tags | array of objects | Retorna només els elements amb les etiquetes donades. Concordança exacta per lectura de btag i cerca que distingeix entre majúscules i minúscules o no distingeix entre majúscules i minúscules pel valor de l'etiqueta en funció del valor de l'operador. Format: [{"tag": "<etiqueta>", "valor": " <valor>", " operador": "<operador>"}, ...].Una matriu buida retorna tots els elements. Tipus d'operadors possibles: 0 - (per defecte) És com; 1 - Igual; 2 - No és com; 3 - No és igual 4 - Existeix; 5 - No existeix. |
| with_triggers | boolean | Si s'estableix a true, només retorna els elements emprats als triggers. |
| selectHosts | query | Retorna una propietat equips que conté una matriu d'equips a què pertany l'element. |
| selectInterfaces | query | Retorna una propietat interfícies que conté una matriu d'interfícies d'equip emprades per l'element. |
| selectTriggers | query | Retorna una propietat triggers que conté els triggers que empra aquest element. Admet count. |
| selectGraphs | query | Retorna una propietat gràfics que conté els gràfics que empra l'element. Admet count. |
| selectDiscoveryRule | query | Retorna una propietat regla de descoberta que conté la regla de descoberta de baix nivell que va crear l'element. |
| selectItemDiscovery | query | Retorna l'objecte de descoberta d'elements a la propietat itemDiscovery. L'objecte de descoberta d'elements enllaça l'element a un prototip d'element des del qual s'ha creat.Té les propietats següents: itemdiscoveryid - (cadena) Identificador de descoberta de l'element;itemid - (cadena) Identificació de l'element descobert ;parent_itemid - (cadena) Identificador del prototip d'element des del qual s'ha creat l'element;key_ - (cadena) clau del prototip de l'element;< br>lastcheck - (timestamp) quan l'element es va descobrir per última vegada;< br>ts_delete - (timestamp) quan s'esborrarà un element que ja no es descobreix. |
| selectPreprocessing | query | Retorna una propietat preprocessament que conté opcions de preprocessament d'elements. Té les propietats següents: type - (cadena) Tipus d'opcions de preprocessament:1 - Multiplicador personalitzat; 2 - Eliminació d'espais en blanc al final; 3 - Eliminació d'espais en blanc al final; 4 - Eliminació dels espais inicials i finals; 5 - Coincidència d'expressió regular; 6 - Booleà a decimal; 7 - Octal a decimal; 8 - Hexadecimal a decimal; 9 - Canvi únic; 10 - Canvi per segon;<br >11 - XML XPath; 12 - JSONPath; 13 - Dins l'interval; 14 - Coincideix amb l'expressió regular ; 15 - No coincideix amb l'expressió regular ; 16 - Troba l'error en JSON ; 17 - Trobar l'error en XML ; 18 - Trobar l'error amb una expressió regular; 19 - Suprimir sense modificacions; 20 - Suprimeix sense modificacions amb batec; 21 - JavaScript; 22 - Patró de Prometheus; 23 - Prometeu a JSON; 24 - CSV a JSON; 25 - Substituïu ; 26 - Comproveu si hi ha valors no compatibles ; 27 - XML a JSON. params - (string) Paràmetres addicionals emprats per l'opció de preprocessament. Diversos paràmetres són separats per un caràcter LF (\n).error_handler - (cadena) Tipus d'acció que s'empra en l'error del pas de preprocessament:0 - El servidor Zabbix defineix el missatge d'error; 1 - Elimina el valor; 2 - Estableix un valor personalitzat; 3 - Estableix un missatge d'error personalitzat. error_handler_params - (cadena) Paràmetres del gestor d'errors. |
| selectTags | query | Retorna etiquetes d'element a la propietat etiquetes. |
| selectValueMap | query | Retorna una propietat mapa de valors que conté el mapa de valors de l'element. |
| filter | object | Només retorna resultats que coincideixen exactament amb el filtre donat. Accepta una matriu on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.< br> Admet filtres addicionals: host - Nom tècnic de l'equip al qual pertany l'element. |
| limitSelects | integer | Limita el nombre de registres retornats per les subconsultes. S'aplica a les subconsultes següents: selectGraphs: els resultats s'ordenaran per nom;< br>selectTriggers: resultats s'ordenarà per descripció. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Els valors possibles són: itemid, name, key_, delay, history, trends , tipus i estat. |
| countOutput | boolean | Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Cercar elements per una clau
Recupera tots els elements emprats amb l'ID d'equip específics que contenen el mot "system.cpu" a la clau d'element, i ordenar els resultats per nom.
Petició:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"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
}Cercar elements dependents, per clau
Recuperar tots els elements dependents de l'equip amb ID "10116" donada una clau que conté el nom "apache".
Petició:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"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
}Trobar un element d'agent HTTP
Trobar un element d'agent HTTP amb el tipus de cos XML per a un ID d'equip donat.
Petició:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 3,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Resposta:
{
"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
}Cercar elements amb regles de pretractament
Recuperar tots els elements i les seves regles de pretractament per un ID d'equip específic.
Petició:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"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
}Veieu també
Font
CItem::get() in ui/include/classes/api/services/CItem.php.