Documentation
Table of Contents
> Element objecte
Els següents objectes tenen relació directa amb l'API item.
Element
Els elements web no es poden crear, actualitzar o esborrar directament mitjançant l'API de Zabbix.
L'objecte element té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| itemid | string | (només lectura) ID de l'element. |
| delay (obligatori) |
string | Interval d'actualització de l'element. Accepta segons o una unitat de temps amb sufix (30s, 1m, 2h, 1d). Opcionalment, un o més intervals personalitzats es poden especificar com a intervals flexibles o com una programació. Múltiples intervals estan separats per un punt i coma. Es poden emprar macros d'usuari. Una sola macro hauria d'omplir tot el camp. No s'admeten pas diverses macros en un camp o macros barrejades amb text. Els intervals flexibles es poden escriure com dues macros separades per una barra inclinada (p. ex., {$FLEX_INTERVAL}/ {$FLEX_PERIOD}).<br >Opcional per a Zabbix trapper, elements dependents i per a agent Zabbix (actiu) amb la clau mqtt.get. |
| hostid (obligatori) |
string | ID de l'equip o del model al qual pertany l'element. Per a les operacions d'actualització, aquest camp és només lectura. |
| interfaceid (obligatori) |
string | Id de la interfície d'equip de l'element. Només s'empra per als elements de l'equip. No és necessari per a l'agent Zabbix (actiu), Zabbix intern, Zabbix trapper, calculat, dependent, monitor de base de dades i elements d'script. Opcional per als elements de l'agent HTTP. |
| key_ (obligatori) |
string | clau d'element. |
| name (obligatori) |
string | Nom de l'element. |
| type (obligatori) |
integer | Tipus d'element Valors possibles: 0 - Agent Zabbix; 2 - Trapper Zabbix; 3 - Verificació simple; 5 - Zabbix intern; 7 - Agent Zabbix (actiu); 9 - Element web; 10 - Verificació externa; 11 - Monitor de base de dades;< 12 - Agent IPMI;< br>13 - Agent SSH; 14 - Agent Telnet; 15 - Calculat; 16 - Agent JMX; 17 - Trampa SNMP; 18 - Element dependent; 19 - Agent HTTP; 20 - Agent SNMP; 21 - Script |
| url (obligatori) |
string | cadena d'URL, necessària només per al tipus d'element d'agent HTTP. Admet macros d'usuari, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| value_type (obligatori) |
integer | Tipus d'informació de l'element. Valors possibles: 0 - nombre flotant; 1 - caràcter; 2 - diari; 3 - digital sense signe; 4 - text. |
| allow_traps | integer | camp d'element de l'agent HTTP. També permet l'ampliació de valors com en el tipus d'element trapper. 0 - (per defecte) No permet acceptar dades entrants. 1 - Permet acceptar dades entrants. |
| authtype | integer | Només l'empren els elements de l'agent SSH o els elements de l'agent HTTP. Valors possibles per al mètode d'autenticació de l'agent SSH: 0 - mot de pas (per defecte); 1 - clau pública. Valors possibles del mètode d'autenticació de l'agent HTTP: 0 - (per defecte) cap 1 - Bàsic 2 - NTLM 3 - Kerberos |
| description | string | Descripció de l'element. |
| error | string | (només lectura) Text d'error si hi ha problemes per actualitzar el valor de l'element. |
| flags | integer | (només lectura) Origen de l'objecte. Valors possibles: 0 - Objecte normal; 4 - Objecte descobert. |
| follow_redirects | integer | Camp d'element de l'agent HTTP. Seguiu les redireccions de respostes mentre afegiu dades. 0 - No seguiu les redireccions. 1 - (per defecte) Seguiu les redireccions. |
| headers | object | Camp d'element de l'agent HTTP. Objecte amb capçaleres de petició HTTP(S), on el nom de la capçalera s'empra com a clau i el valor de la capçalera com a valor. Exemple: { " User-Agent": "Zabbix" } |
| history | string | Unitat de temps que indica quant de temps s'han d'emmagatzemar les dades de l'històric. També accepta macros d'usuari. Per defecte: 90d. |
| http_proxy | string | camp d'element de l'agent HTTP. Cadena de connexió del proxy HTTP(S). |
| inventory_link | integer | ID del camp d'inventari de l'equip emplenat per l'element. Consulteu la pàgina d'inventari d'equip per obtindre una llista de camps d'inventari d'equip admesos i els seus identificadors. Per defecte: 0. |
| ipmi_sensor | string | sensor IPMI. Emprat només per elements IPMI. |
| jmx_endpoint | string | Cadena de connexió de l'agent JMX personalitzada. Per defecte: service:jmx:rmi:///jndi/rmi://{HOST.CONN} :{HOST.PORT} /jmxrmi |
| lastclock | timestamp | (només lectura) Hora en què el valor de l'element es va actualitzar per darrer cop. Per defecte, només es mostren els valors de les darreres 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. |
| lastns | integer | (només lectura) Nanosegons de la darrera actualització del valor de l'element. De manera predeterminada, només es mostren els valors de les darreres 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. |
| lastvalue | string | (només lectura) Darrer valor de l'element. Per defecte, només es mostren els valors de les darreres 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. |
| logtimefmt | string | Format d'hora a les entrades de registre. Emprat només per elements de registre. |
| master_itemid | integer | Identificador d'element principal. Es permet la recurrència de fins a 3 elements dependents i el nombre màxim d'elements dependents de 29.999. Obligatori per elements dependents. |
| output_format | integer | Camp d'element de l'agent HTTP. En cas de convertir la resposta a JSON. 0 - (per defecte) Emmagatzema en brut. 1 - Converteix a JSON. |
| params | string | Paràmetres addicionals en funció del tipus d'element: - script executat per a elements SSH i Telnet; - consulta SQL per a elements de supervisió de la base de dades; - fórmula per als elements calculats; - l'script per a un element d'script. |
| parameters | array | Paràmetres addicionals per als elements de l'script. Matriu d'objectes amb propietats "nom" i "valor", on el nom ha d'ésser únic. |
| password | string | Mot de pas per a l'autenticació. S'empra per simple comprovació, SSH, Telnet, monitor de base de dades, elements de l'agent JMX i HTTP. Quan s'empra per JMX, el nom d'usuari també s'ha d'especificar amb mot de pas o ambdues propietats s'han de deixar buides. |
| post_type | integer | camp d'element de l'agent HTTP. Tipus de cos de dades de publicació emmagatzemat a la propietat de publicacions. 0 - (per defecte) Dades en brut. 2 - Dades JSON. 3 - Dades XML. |
| posts | string | camp d'element de l'agent HTTP. HTTP(S) demana dades del cos. S'empra amb post_type. |
| prevvalue | string | (només lectura) Valor anterior de l'element. Per defecte, només es veuen els valors de les últimes 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. |
| privatekey | string | Nom del fitxer de clau privada. |
| publickey | string | Nom del fitxer de clau pública. |
| query_camps | array | Camp d'element de l'agent HTTP. Paràmetres de consulta. Matriu d'objectes amb parells 'clau':'valor', on el valor pot ésser una cadena buida. |
| request_method | integer | Camp d'element de l'agent HTTP. Tipus de mètode de petició. 0 - (per defecte) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | camp d'element de l'agent HTTP. Quina part de la resposta s'ha d'emmagatzemar. 0 - (per defecte) Cos. 1 - Capçaleres. 2 - S'emmagatzemaran el cos i les capçaleres.< br> Per request_method HEAD only 1 és el valor permès. |
| snmp_oid | string | SNMP OID. |
| ssl_cert_file | string | Camp d'element de l'agent HTTP. Camí al fitxer de clau SSL pública. |
| ssl_key_file | string | Camp d'element de l'agent HTTP. Camí al fitxer de clau SSL privada. |
| ssl_key_password | string | Camp d'element de l'agent HTTP. Mot de pas per al fitxer de clau SSL. |
| state | integer | (només lectura) Estat de l'element. Valors possibles: 0 - (per defecte) normal; 1 - no compatible. |
| state | integer | Estat de l'element. Valors possibles: 0 - element activat (per defecte); 1 - element desactivat. |
| status_codes | string | camp d'element de l'agent HTTP. Intervals de codis d'estat HTTP obligatoris separats per comes. També admet macros d'usuari com a part d'una llista separada per comes. Exemple: 200.200-{$M},{$M},200-400 |
| templateid | string | (només lectura) ID de l'element de la plantilla principal. Consell: Empreu la propietat hostid per especificar la plantilla a la qual pertany l'element. |
| timeout | string | Temps d'espera de la petició de consulta de dades d'element. S'empra per a agents HTTP i elements d'script. Admet macros d'usuari. valor per defecte: 3s valor màxim: 60s |
| trapper_hosts | string | Equips permesos. Emprat per elements trapper o elements d'agent HTTP. |
| trends | string | Unitat de temps de quant de temps s'han d'emmagatzemar les dades de tendències. També accepta macros d'usuari. Per defecte: 365d. |
| units | string | Unitats de valor. |
| username | string | Nom d'usuari per a l'autenticació. Emprat per elements de Simple Check, SSH, Telnet, Database Monitor, JMX i Agent HTTP. Obligatori per elements SSH i Telnet. Quan empra JMX, el mot de pas també s'ha d'especificar amb el nom d'usuari o ambdues les propietats s'han de deixar en blanc. |
| uuid | string | Identificador únic universal, emprat per enllaçar un element importat amb elements ja existents. S'empra només per a articles de model. Es genera automàticament, si no es proporciona. Per a les operacions d'actualització, aquest camp és només lectura. |
| valuemapid | string | ID de la taula. coincidència de valors associats. |
| verify_host | integer | camp d'element d'agent HTTP. Valideu que el nom d'equip a l'URL estigui al camp Nom comú o Nom alternatiu del subjecte del certificat d'equip. 0 - (per defecte) No valida. 1 - Valida. |
| verify_peer | integer | camp d'element de l'agent HTTP. Valida si el certificat de l'equip és autèntic. 0 - (per defecte) No valida. 1 - Valida. |
Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.
Etiqueta d'element
L'objecte d'etiqueta d'element té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| tag (obligatori) |
string | Nom de l'etiqueta d'element. |
| value | string | Valor de l'etiqueta d'element. |
### Preprocessament de l'element
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| tipus (obligatori) |
integer | El tipus d'opció de preprocessament. Valors possibles: 1 - Multiplicador personalitzat; 2 - Retalla a la dreta;< br>3 - Retalla a l'esquerra; 4 - Retalla; 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; 11 - XML XPath; 12 - JSONPath; 13 - Dins l'interval; 14 - Coincideix amb l'expressió regular;< br>15 - No coincideix amb l'expressió regular; 16 - Comprova si hi ha errors en JSON; 17 - Comprova si hi ha errors en XML; 18 - Comprova si hi ha errors mitjançant una expressió regular; 19 - Descartar sense canvis; 20 - Descartar sense canvis amb un heartbeat; 21 - JavaScript; 22 - Patró de Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Substituïu; >26 - No s'admet la verificació; 27 - XML a JSON. |
| params (obligatori) |
string | Paràmetres addicionals emprats per l'opció de preprocessament. Diversos paràmetres són separats pel caràcter LF (\n). |
| error_handler (obligatori) |
integer | Tipus d'acció que s'empra quan falla el pas de preprocessament. Valors possibles: 0 - Zabbix defineix el missatge d'error del missatge;< br>1 - Elimina el valor; 2 - Estableix un valor personalitzat; 3 - Estableix un missatge d'error personalitzat. |
| error_handler_params (obligatori) |
string | Paràmetres del gestor d'errors. S'empra amb error_handler.Ha d'ésser buit, si error_handler és 0 o 1.Pot ésser buit si error_handler és 2.No pot ésser buit, si error_handler és 3. |
Els següents paràmetres i gestors d'errors són compatibles per a cada tipus de preprocessament.
|Tipus de preprocessament|Nom|Paràmetre 1|Paràmetre 2|Paràmetre 3|Gestors d'errors admesos| |------------------|----|------------|-----------|-- ---------|---------| |1|Multiplicador personalitzat|nombre1,\6|<|<|0, 1, 2, 3| |2|Retalla a la dreta|llista de caràcters2|<|<|<| |3|Retalla a l'esquerra|llista de caràcters2|<|<|<| |4|Retalla|llista de caràcters2|<|<|<| |5|Expressió regular|patró3|sortida2|<|0, 1, 2, 3| |6|Booleà a decimal|<|<|<|0, 1, 2, 3| |7|Octal a decimal|<|<|<|0, 1, 2, 3| |8|Hexadecimal a decimal|<|<|<|0, 1, 2, 3| |9|Canvi únic|<|<|<|0, 1, 2, 3| |10|Canvi per segon|<|<|<|0, 1, 2, 3| |11|XML XPath|camí4|<|<|0, 1, 2, 3| |12|JSONPath|camí4|<|<|0, 1, 2, 3| |13|Dins de l'interval|min1, 6|max1, 6|<|0, 1, 2, 3| |14|Coincideix amb l'expressió regular|patró3|<|<|0, 1, 2, 3| |15|No coincideix amb l'expressió regular|patró3|<|<|0, 1, 2, 3| |16|Comprova l'error a JSON|camí4|<|<|0, 1, 2, 3| |17|Comprova l'error en XML|camí4|<|<|0, 1, 2, 3| |18|Comprova si hi ha errors emprant l'expressió regular|patró3|sortida2|<|0, 1, 2, 3| |19|Descarta el que no ha canviat|<|<|<|<| |20|Descarta el no canviat amb un heartbeat|segons5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Patró de Prometheus|patró6,\7|valor, etiqueta, funció|sortida8,\9|0, 1, 2, 3| |23|Prometheus a JSON|patró6,\7|<|<|0, 1, 2, 3| |24|CSV a JSON|char2|char2|0,1|0, 1, 2, 3| |25|Substitueix|cadena de cerca2|substitueix2|<|<| |26|La verificació no és compatible|<|<|<|1, 2, 3| |27|XML a JSON|<|<|<|0, 1, 2, 3|
1 nombre enter o coma flotant
2 cadena
3 expressió regular
4 JSONPath o XML XPath
5 enter positiu (amb suport per a sufixos de temps, per exemple, 30s, 1m, 2h, 1d)
6 macro d'usuari
7 El model de Prometheus segueix la sintaxi: <nom mètric>{<nom de l'etiqueta>="<valor de l'etiqueta>", ...} == <valor>. Cada component del patró de Prometheus (mètrica, nom d'etiqueta, valor d'etiqueta i valor de mètrica) pot ser una macro d'usuari. 8 Prometheus mostra la següent sintaxi: <nom de l'etiqueta> (pot ser una macro d'usuari) si etiqueta està seleccionada com a segon paràmetre.
9 Una de les funcions agregades: sum, min, max, avg, count si function està seleccionat com a segon paràmetre.