Documentation
Table of Contents
> Objeto de artículo
Los siguientes objetos están directamente relacionados con la API 'item'.
Item
Web items cannot be directly created, updated or deleted via the Zabbix API.
The item object has the following properties.
| Property | Type | Description |
|---|---|---|
| itemid | string | (readonly) ID of the item. |
| delay (required) |
string | Update interval of the item. Accepts seconds or a time unit with suffix (30s,1m,2h,1d). Optionally one or more custom intervals can be specified either as flexible intervals or scheduling. Multiple intervals are separated by a semicolon. User macros may be used. A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported. Flexible intervals may be written as two macros separated by a forward slash (e.g. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Optional for Zabbix trapper, dependent items and for Zabbix agent (active) with mqtt.get key. |
| hostid (required) |
string | ID of the host or template that the item belongs to. For update operations this field is readonly. |
| interfaceid (required) |
string | ID of the item's host interface. Not required for template items. Optional for internal, active agent, trapper, calculated, dependent and database monitor items. |
| key_ (required) |
string | Item key. |
| name (required) |
string | Name of the item. |
| type (required) |
integer | Type of the item. Possible values: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 9 - Web item; 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - Telnet agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script |
| url (required) |
string | URL string, required only for HTTP agent item type. Supports user macros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| value_type (required) |
integer | Type of information of the item. Possible values: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text. |
| allow_traps | integer | HTTP agent item field. Allow to populate value as in trapper item type also. 0 - (default) Do not allow to accept incoming data. 1 - Allow to accept incoming data. |
| authtype | integer | Used only by SSH agent items or HTTP agent items. SSH agent authentication method possible values: 0 - (default) password; 1 - public key. HTTP agent authentication method possible values: 0 - (default) none 1 - basic 2 - NTLM 3 - Kerberos |
| description | string | Description of the item. |
| error | string | (readonly) Error text if there are problems updating the item. |
| flags | integer | (readonly) Origin of the item. Possible values: 0 - a plain item; 4 - a discovered item. |
| follow_redirects | integer | HTTP agent item field. Follow response redirects while pooling data. 0 - Do not follow redirects. 1 - (default) Follow redirects. |
| headers | object | HTTP agent item field. Object with HTTP(S) request headers, where header name is used as key and header value as value. Example: { "User-Agent": "Zabbix" } |
| history | string | A time unit of how long the history data should be stored. Also accepts user macro. Default: 90d. |
| http_proxy | string | HTTP agent item field. HTTP(S) proxy connection string. |
| inventory_link | integer | ID of the host inventory field that is populated by the item. Refer to the host inventory page for a list of supported host inventory fields and their IDs. Default: 0. |
| ipmi_sensor | string | IPMI sensor. Used only by IPMI items. |
| jmx_endpoint | string | JMX agent custom connection string. Default value: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| lastclock | timestamp | (readonly) Time when the item was last updated. By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of Max history display period parameter in the Administration → General menu section. |
| lastns | integer | (readonly) Nanoseconds when the item was last updated. By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of Max history display period parameter in the Administration → General menu section. |
| lastvalue | string | (readonly) Last value of the item. By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of Max history display period parameter in the Administration → General menu section. |
| logtimefmt | string | Format of the time in log entries. Used only by log items. |
| master_itemid | integer | Master item ID. Recursion up to 3 dependent items and maximum count of dependent items equal to 29999 are allowed. Required by dependent items. |
| output_format | integer | HTTP agent item field. Should response be converted to JSON. 0 - (default) Store raw. 1 - Convert to JSON. |
| params | string | Additional parameters depending on the type of the item: - executed script for SSH and Telnet items; - SQL query for database monitor items; - formula for calculated items; - the script for script item. |
| parameters | array | Additional parameters for script items. Array of objects with 'name' and 'value' properties, where name must be unique. |
| password | string | Password for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items. When used by JMX, username should also be specified together with password or both properties should be left blank. |
| post_type | integer | HTTP agent item field. Type of post data body stored in posts property. 0 - (default) Raw data. 2 - JSON data. 3 - XML data. |
| posts | string | HTTP agent item field. HTTP(S) request body data. Used with post_type. |
| prevvalue | string | (readonly) Previous value of the item. By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of Max history display period parameter in the Administration → General menu section. |
| privatekey | string | Name of the private key file. |
| publickey | string | Name of the public key file. |
| query_fields | array | HTTP agent item field. Query parameters. Array of objects with 'key':'value' pairs, where value can be empty string. |
| request_method | integer | HTTP agent item field. Type of request method. 0 - (default) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | HTTP agent item field. What part of response should be stored. 0 - (default) Body. 1 - Headers. 2 - Both body and headers will be stored. For request_method HEAD only 1 is allowed value. |
| snmp_oid | string | SNMP OID. |
| ssl_cert_file | string | HTTP agent item field. Public SSL Key file path. |
| ssl_key_file | string | HTTP agent item field. Private SSL Key file path. |
| ssl_key_password | string | HTTP agent item field. Password for SSL Key file. |
| state | integer | (readonly) State of the item. Possible values: 0 - (default) normal; 1 - not supported. |
| status | integer | Status of the item. Possible values: 0 - (default) enabled item; 1 - disabled item. |
| status_codes | string | HTTP agent item field. Ranges of required HTTP status codes separated by commas. Also supports user macros as part of comma separated list. Example: 200,200-{$M},{$M},200-400 |
| templateid | string | (readonly) ID of the parent template item. Hint: Use the hostid property to specify the template that the item belongs to. |
| timeout | string | Item data polling request timeout. Used for HTTP agent and script items. Supports user macros. default: 3s maximum value: 60s |
| trapper_hosts | string | Allowed hosts. Used by trapper items or HTTP agent items. |
| trends | string | A time unit of how long the trends data should be stored. Also accepts user macro. Default: 365d. |
| units | string | Value units. |
| username | string | Username for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items. Required by SSH and Telnet items. When used by JMX, password should also be specified together with username or both properties should be left blank. |
| uuid | string | Universal unique identifier, used for linking imported item to already existing ones. Used only for items on templates. Auto-generated, if not given. For update operations this field is readonly. |
| valuemapid | string | ID of the associated value map. |
| verify_host | integer | HTTP agent item field. Validate host name in URL is in Common Name field or a Subject Alternate Name field of host certificate. 0 - (default) Do not validate. 1 - Validate. |
| verify_peer | integer | HTTP agent item field. Validate is host certificate authentic. 0 - (default) Do not validate. 1 - Validate. |
Etiqueta de la métrica
El objeto de etiqueta de métrica tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tag (obligatorio) |
cadena | Nombre de etiqueta de la métrica. |
| value | cadena | Valor de etiqueta de la métrica. |
Preprocesamiento de artículos
El objeto de preprocesamiento de elementos tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tipo (obligatorio) |
entero | El tipo de opción de preprocesamiento. Valores posibles: 1 - Multiplicador personalizado; 2 - Recorte derecho; 3 - Recorte izquierdo; 4 - Recortar; 5 - Coincidencia de expresiones regulares; 6 - Booleano a decimal; 7 - Octal a decimal; 8 - Hexadecimal a decimal; 9 - Cambio simple; 10 - Cambio por segundo; 11 - XML XPath; 12 - JSONPath; 13 - Dentro del rango; 14 - Coincide con expresiones regulares; 15 - No coincide con la expresión regular; 16 - Verificar errores en JSON; 17 - Verificar errores en XML; 18 - Verificar errores usando expresiones regulares; 19 - Descartar sin cambios;<br >20 - Descartar sin cambios con latido; 21 - JavaScript; 22 - Patrón de Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Reemplazar;<br >26 - Marcar no compatible; 27 - XML a JSON. |
| params (obligatorio) |
cadena | Parámetros adicionales utilizados por la opción de preprocesamiento. Varios parámetros están separados por el carácter LF (\n). |
| error_handler (obligatorio) |
entero | Tipo de acción utilizado en caso de error en el paso de preprocesamiento. Valores posibles: 0: el servidor Zabbix establece el mensaje de error;< br>1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. |
| error_handler_params (obligatorio) |
cadena | Parámetros del controlador de errores. Se usa con error_handler.Debe estar vacío, si error_handler es 0 o 1.Puede estar vacío si error_handler es 2.No puede estar vacío, si error_handler es 3. |
Los siguientes parámetros y controladores de errores son compatibles con cada tipo de preprocesamiento.
|Tipo de preprocesamiento|Nombre|Parámetro 1|Parámetro 2|Parámetro 3|Manejadores de errores admitidos| |------------------|----|-----------|-----------|- ----------|---------------------------------| |1|Multiplicador personalizado|número1, 6|<|<|0, 1, 2, 3| |2|Recorte derecho|lista de caracteres2|<|<|<| |3|Recorte izquierdo|lista de caracteres2|<|<|<| |4|Recortar|lista de caracteres2|<|<|<| |5|Expresión regular|patrón3|salida2|<|0, 1, 2, 3| |6|Booleano a decimal|<|<|<|0, 1, 2, 3| |7|Octal a decimal|<|<|<|0, 1, 2, 3| |8|Hexadecimal a decimal|<|<|<|0, 1, 2, 3| |9|Cambio simple|<|<|<|0, 1, 2, 3| |10|Cambio por segundo|<|<|<|0, 1, 2, 3| |11|XML XPath|ruta4|<|<|0, 1, 2, 3| |12|JSONPath|ruta4|<|<|0, 1, 2, 3| |13|En el rango|min1, 6|max1, 6|<|0, 1, 2, 3| |14|Coincide con la expresión regular|patrón3|<|<|0, 1, 2, 3| |15|No coincide con la expresión regular|patrón3|<|<|0, 1, 2, 3| |16|Compruebe si hay errores en JSON|ruta4|<|<|0, 1, 2, 3| |17|Compruebe si hay errores en XML|ruta4|<|<|0, 1, 2, 3| |18|Compruebe si hay errores usando la expresión regular|patrón3|salida2|<|0, 1, 2, 3| |19|Descartar sin cambios|<|<|<|<| |20|Descartar sin cambios con latido|segundos5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Patrón de Prometeo|patrón6, 7|valor, etiqueta, función|salida8, 9|0, 1, 2, 3| |23|Prometeo a JSON|patrón6, 7|<|<|0, 1, 2, 3| |24|CSV a JSON|carácter2|carácter2|0,1|0, 1, 2, 3| |25|Reemplazar|cadena de búsqueda2|reemplazo2|<|<| |26|Comprobación no admitida|<|<|<|1, 2, 3| |27|XML a JSON|<|<|<|0, 1, 2, 3|
1 número entero o de punto flotante
2 cadena
3 expresión regular
4 JSONPath o XML XPath
5 entero positivo (con soporte de sufijos de tiempo, por ejemplo, 30s, 1m, 2h, 1d)
6 macro de usuario
7 Patrón de Prometheus siguiendo la sintaxis: <nombre de métrica>{<nombre de etiqueta>="<valor de etiqueta>", ...} == <valor>. Cada Componente del patrón Prometheus (métrica, nombre de etiqueta, valor de etiqueta y métrica) valor) puede ser una macro de usuario.
8 Salida de Prometheus siguiendo la sintaxis: <nombre de etiqueta> (puede ser una macro de usuario) si se selecciona etiqueta como segundo parámetro.
9 Una de las funciones de agregación: suma, min, max, avg, count si se selecciona función como segundo parámetro.