En esta página
Objeto de métrica
Los siguientes objetos están directamente relacionados con la API de métrica.
Item
Los web items no se pueden crear, actualizar ni eliminar directamente mediante la API de Zabbix.
El objeto item tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID del item. Property behavior: - solo lectura - obligatorio para operaciones de actualización |
| delay | string | Intervalo de actualización del item. Acepta segundos o una unidad de tiempo con sufijo (por ejemplo, 30s, 1m, 2h, 1d) y, opcionalmente, uno o más intervalos personalizados, todos separados por punto y coma. Los intervalos personalizados pueden ser una combinación de intervalos flexibles y de programación. Acepta macros de usuario. Si se usa, el valor debe ser una sola macro. No se admiten varias macros ni macros mezcladas con texto. Los intervalos flexibles pueden escribirse como dos macros separadas por una barra diagonal (por ejemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Ejemplo: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Property behavior: - obligatorio si type está establecido en "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), o si type está establecido en "Zabbix agent (active)" (7) y key_ no contiene "mqtt.get" |
| hostid | ID | ID del host o template al que pertenece el item. Property behavior: - constante - obligatorio para operaciones de creación |
| interfaceid | ID | ID de la interfaz de host del item. Property behavior: - obligatorio si el item pertenece a un host y type está establecido en "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" o "SNMP agent"- compatible si el item pertenece a un host y type está establecido en "Simple check", "External check", "SSH agent", "TELNET agent" o "HTTP agent"- solo lectura para objetos descubiertos |
| key_ | string | Clave del item. Property behavior: - obligatorio para operaciones de creación - solo lectura para objetos heredados u objetos descubiertos |
| name | string | Nombre del item. Admite macros de usuario. Property behavior: - obligatorio para operaciones de creación - solo lectura para objetos heredados u objetos descubiertos |
| name_resolved | string | Nombre del item con las macros de usuario resueltas. Property behavior: - solo lectura |
| type | integer | Tipo del item. Valores posibles: 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; 22 - Browser. Property behavior: - obligatorio para operaciones de creación - solo lectura para objetos heredados u objetos descubiertos |
| url | string | Cadena URL. Admite macros de usuario, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. Property behavior: - obligatorio si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| value_type | integer | Tipo de información del item. Valores posibles: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary. Property behavior: - obligatorio para operaciones de creación - solo lectura para objetos heredados u objetos descubiertos |
| allow_traps | integer | Permite rellenar el valor de forma similar al item trapper. 0 - (predeterminado) No permitir aceptar datos entrantes; 1 - Permitir aceptar datos entrantes. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos descubiertos |
| authtype | integer | Método de autenticación. Valores posibles si type está establecido en "SSH agent":0 - (predeterminado) contraseña; 1 - clave pública. Valores posibles si type está establecido en "HTTP agent":0 - (predeterminado) ninguno; 1 - basic; 2 - NTLM; 3 - Kerberos; 4 - Digest. Property behavior: - compatible si type está establecido en "SSH agent" o "HTTP agent"- solo lectura para objetos heredados (si type está establecido en "HTTP agent") u objetos descubiertos |
| description | string | Descripción del item. Property behavior: - solo lectura para objetos descubiertos |
| error | string | Texto de error si hay problemas al actualizar el valor del item. Property behavior: - solo lectura |
| flags | integer | Origen del item. Valores posibles: 0 - un item normal; 4 - un item descubierto. Property behavior: - solo lectura |
| follow_redirects | integer | Seguir redirecciones de respuesta mientras se consultan datos. Valores posibles: 0 - No seguir redirecciones; 1 - (predeterminado) Seguir redirecciones. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| headers | array | Matriz de headers que se enviarán al realizar una solicitud HTTP. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| history | string | Unidad de tiempo durante la cual deben almacenarse los datos históricos. También acepta macro de usuario. Predeterminado: 31d. Property behavior: - solo lectura para objetos descubiertos |
| http_proxy | string | Cadena de conexión del proxy HTTP(S). Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| inventory_link | integer | ID del campo de inventario del host que se rellena con el item. Consulte la página de inventario del host para obtener una lista de los campos de inventario del host compatibles y sus ID. Predeterminado: 0. Property behavior: - compatible si value_type está establecido en "numeric float", "character", "numeric unsigned" o "text"- solo lectura para objetos descubiertos |
| ipmi_sensor | string | Sensor IPMI. Property behavior: - obligatorio si type está establecido en "IPMI agent" y key_ no está establecido en "ipmi.get"- compatible si type está establecido en "IPMI agent"- solo lectura para objetos heredados u objetos descubiertos |
| jmx_endpoint | string | Cadena de conexión personalizada del agent JMX. Valor predeterminado: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Property behavior: - compatible si type está establecido en "JMX agent"- solo lectura para objetos descubiertos |
| lastclock | timestamp | Momento en que se actualizó por última vez el valor del item. De forma predeterminada, solo se muestran los valores que se encuentran dentro de las últimas 24 horas. Puede ampliar este período de tiempo cambiando el valor del parámetro Max history display period en la sección de menú Administration → General. Property behavior: - solo lectura |
| lastns | integer | Nanosegundos en que se actualizó por última vez el valor del item. De forma predeterminada, solo se muestran los valores que se encuentran dentro de las últimas 24 horas. Puede ampliar este período de tiempo cambiando el valor del parámetro Max history display period en la sección de menú Administration → General. Property behavior: - solo lectura |
| lastvalue | string | Último valor del item. De forma predeterminada, solo se muestran los valores que se encuentran dentro de las últimas 24 horas. Puede ampliar este período de tiempo cambiando el valor del parámetro Max history display period en la sección de menú Administration → General. Property behavior: - solo lectura |
| logtimefmt | string | Formato de la hora en las entradas de registro. Property behavior: - compatible si value_type está establecido en "log"- solo lectura para objetos heredados u objetos descubiertos |
| master_itemid | ID | ID del item maestro. Se permite la recursión de hasta 3 items dependientes y un número máximo de items dependientes igual a 29999. Property behavior: - obligatorio si type está establecido en "Dependent item"- solo lectura para objetos heredados u objetos descubiertos |
| output_format | integer | Indica si la respuesta debe convertirse a JSON. 0 - (predeterminado) Almacenar sin procesar; 1 - Convertir a JSON. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| params | string | Parámetros adicionales según el tipo de item: - script ejecutado para items de SSH agent y TELNET agent; - consulta SQL para items de database monitor; - fórmula para items calculados; - el script para items de script y browser. Property behavior: - obligatorio si type está establecido en "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" o "Browser"- solo lectura para objetos heredados (si type está establecido en "Script" o "Browser") u objetos descubiertos |
| parameters | object/array | Parámetros adicionales si type está establecido en "Script" o "Browser". Matriz de objetos con propiedades name y value, donde name debe ser único.Property behavior: - compatible si type está establecido en "Script" o "Browser"- solo lectura para objetos heredados u objetos descubiertos |
| password | string | Contraseña para autenticación. Property behavior: - obligatorio si type está establecido en "JMX agent" y username está establecido- compatible si type está establecido en "Simple check", "SSH agent", "TELNET agent", "Database monitor" o "HTTP agent"- solo lectura para objetos heredados (si type está establecido en "HTTP agent") u objetos descubiertos |
| post_type | integer | Tipo del cuerpo de datos de post almacenado en la propiedad posts.Valores posibles: 0 - (predeterminado) Datos sin procesar; 2 - Datos JSON; 3 - Datos XML. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| posts | string | Datos del cuerpo de la solicitud HTTP(S). Property behavior: - obligatorio si type está establecido en "HTTP agent" y post_type está establecido en "JSON data" o "XML data"- compatible si type está establecido en "HTTP agent" y post_type está establecido en "Raw data"- solo lectura para objetos heredados u objetos descubiertos |
| prevvalue | string | Valor anterior del item. De forma predeterminada, solo se muestran los valores que se encuentran dentro de las últimas 24 horas. Puede ampliar este período de tiempo cambiando el valor del parámetro Max history display period en la sección de menú Administration → General. Property behavior: - solo lectura |
| privatekey | string | Nombre del archivo de clave privada. Property behavior: - obligatorio si type está establecido en "SSH agent" y authtype está establecido en "public key"- solo lectura para objetos descubiertos |
| publickey | string | Nombre del archivo de clave pública. Property behavior: - obligatorio si type está establecido en "SSH agent" y authtype está establecido en "public key"- solo lectura para objetos descubiertos |
| query_fields | array | Matriz de query fields que se enviarán al realizar una solicitud HTTP. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| request_method | integer | Tipo de método de solicitud. Valores posibles: 0 - (predeterminado) GET; 1 - POST; 2 - PUT; 3 - HEAD. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| retrieve_mode | integer | Qué parte de la respuesta debe almacenarse. Valores posibles si request_method está establecido en "GET", "POST" o "PUT":0 - (predeterminado) Body; 1 - Headers; 2 - Se almacenarán tanto el body como los headers. Valores posibles si request_method está establecido en "HEAD":1 - Headers. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| snmp_oid | string | OID SNMP. Property behavior: - obligatorio si type está establecido en "SNMP agent"- solo lectura para objetos heredados u objetos descubiertos |
| ssl_cert_file | string | Ruta del archivo de clave SSL pública. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| ssl_key_file | string | Ruta del archivo de clave SSL privada. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| ssl_key_password | string | Contraseña para el archivo de clave SSL. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| state | integer | Estado del item. Valores posibles: 0 - (predeterminado) normal; 1 - no compatible. Property behavior: - solo lectura |
| status | integer | Estado del item. Valores posibles: 0 - (predeterminado) item habilitado; 1 - item deshabilitado. |
| status_codes | string | Rangos de códigos de estado HTTP requeridos, separados por comas. También admite macros de usuario como parte de una lista separada por comas. Ejemplo: 200,200-{$M},{$M},200-400 Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| templateid | ID | ID del item de template principal. Sugerencia: Use la propiedad hostid para especificar el template al que pertenece el item.Property behavior: - solo lectura |
| timeout | string | Tiempo de espera de la solicitud de sondeo de datos del item. Acepta segundos o una unidad de tiempo con sufijo (por ejemplo, 30s, 1m). También acepta macros de usuario. Rango de valores posibles: 1-600s. Predeterminado: "" - usar la configuración del proxy/global. Property behavior: - compatible si type está establecido en "Zabbix agent" (0), "Simple check" (3) y key_ no comienza con "vmware." ni "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) y snmp_oid comienza con "walk[" o "get[", "Script" (21), "Browser" (22)- solo lectura para objetos heredados y descubiertos |
| trapper_hosts | string | Hosts permitidos. Property behavior: - readonly para objetos descubiertos - compatible si type está establecido en "Zabbix trapper", o si type está establecido en "HTTP agent" y allow_traps está establecido en "Permitir aceptar datos entrantes" |
| trends | string | Unidad de tiempo durante la cual deben almacenarse los datos de tendencias. También acepta macro de usuario. Predeterminado: 365d. Property behavior: - compatible si value_type está establecido en "numeric float" o "numeric unsigned"- solo lectura para objetos descubiertos |
| units | string | Unidades del valor. Property behavior: - compatible si value_type está establecido en "numeric float" o "numeric unsigned"- solo lectura para objetos heredados u objetos descubiertos |
| username | string | Nombre de usuario para autenticación. Property behavior: - obligatorio si type está establecido en "SSH agent", "TELNET agent", o si type está establecido en "JMX agent" y password está establecido- compatible si type está establecido en "Simple check", "Database monitor" o "HTTP agent"- solo lectura para objetos heredados (si type está establecido en "HTTP agent") u objetos descubiertos |
| uuid | string | Identificador único universal, usado para vincular el item importado con los ya existentes. Se genera automáticamente si no se proporciona. Property behavior: - compatible si el item pertenece a un template |
| valuemapid | ID | ID del mapa de valores asociado. Property behavior: - compatible si value_type está establecido en "numeric float", "character" o "numeric unsigned"- solo lectura para objetos heredados u objetos descubiertos |
| verify_host | integer | Si se debe validar que el nombre de host de la conexión coincida con el del certificado del host. Valores posibles: 0 - (predeterminado) No validar; 1 - Validar. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
| verify_peer | integer | Si se debe validar que el certificado del host sea auténtico. Valores posibles: 0 - (predeterminado) No validar; 1 - Validar. Property behavior: - compatible si type está establecido en "HTTP agent"- solo lectura para objetos heredados u objetos descubiertos |
Encabezado HTTP
El objeto header tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del encabezado HTTP. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del encabezado. Comportamiento de la propiedad: - obligatorio |
Campo de consulta HTTP
El objeto de campo de consulta define un nombre y un valor que se utilizan para especificar un parámetro de URL. Tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del parámetro. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del parámetro. Comportamiento de la propiedad: - obligatorio |
Etiqueta de item
El objeto de etiqueta de item tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| tag | string | Nombre de la etiqueta de item. Property behavior: - required |
| value | string | Valor de la etiqueta de item. |
Preprocesamiento de item
El objeto de preprocesamiento de item tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| type | integer | El tipo de opción de preprocesamiento. Valores posibles: 1 - Multiplicador personalizado; 2 - Recorte a la derecha; 3 - Recorte a la izquierda; 4 - Recortar; 5 - Expresión regular; 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 - En rango; 14 - Coincide con expresión regular; 15 - No coincide con expresión regular; 16 - Comprobar error en JSON; 17 - Comprobar error en XML; 18 - Comprobar error usando expresión regular; 19 - Descartar sin cambios; 20 - Descartar sin cambios con heartbeat; 21 - JavaScript; 22 - Patrón de Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Reemplazar; 26 - Comprobar no compatible; 27 - XML a JSON; 28 - Valor de recorrido SNMP; 29 - Recorrido SNMP a JSON; 30 - Obtener valor SNMP. Property behavior: - required |
| params | string | Parámetros adicionales usados por la opción de preprocesamiento. Los múltiples parámetros se separan con el carácter de nueva línea (\n). Si type está establecido en "Check unsupported", los parámetros siguen la sintaxis <scope>[\n<pattern>], donde pattern es una expresión regular y scope es uno de los siguientes:-1 - coincide con cualquier error; \ 0 - comprobar si el mensaje de error coincide con pattern; \ 1 - comprobar si el mensaje de error no coincide con pattern. Property behavior: - required si type está establecido en "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), Check unsupported (26), "SNMP walk value" (28), "SNMP walk to JSON" (29), o "SNMP get value" (30) |
| error_handler | integer | Tipo de acción usado en caso de fallo del paso de preprocesamiento. Valores posibles: 0 - El mensaje de error es establecido por el server de Zabbix; 1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. Valores posibles si type está establecido en "Check unsupported":1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. Property behavior: - required si type está establecido en "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), o "SNMP get value" (30) |
| error_handler_params | string | Parámetros del manejador de errores. Property behavior: - required si error_handler está establecido en "Set custom value" o "Set custom error message" |
Los siguientes parámetros y manejadores de errores son compatibles con cada tipo de preprocesamiento.
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Multiplicador personalizado | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Recorte a la derecha | list of characters2 | |||
| 3 | Recorte a la izquierda | list of characters2 | |||
| 4 | Recortar | list of characters2 | |||
| 5 | Expresión regular | pattern3 | output2 | 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 | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | En rango | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Coincide con expresión regular | pattern3 | 0, 1, 2, 3 | ||
| 15 | No coincide con expresión regular | pattern3 | 0, 1, 2, 3 | ||
| 16 | Comprobar error en JSON | path4 | 0, 1, 2, 3 | ||
| 17 | Comprobar error en XML | path4 | 0, 1, 2, 3 | ||
| 18 | Comprobar error usando expresión regular | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Descartar sin cambios | ||||
| 20 | Descartar sin cambios con heartbeat | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Patrón de Prometheus | pattern6, 7 | value, label, function |
output8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus a JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV a JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Reemplazar | search string2 | replacement2 | ||
| 26 | Comprobar no compatible | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML a JSON | 0, 1, 2, 3 | |||
| 28 | Valor de recorrido SNMP | OID2 | Format: 0 - Sin cambios 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 | |
| 29 | Recorrido SNMP a JSON10 | Field name2 | OID prefix2 | Format: 0 - Sin cambios 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 |
| 30 | Obtener valor SNMP | Format: 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 | ||
1 número de punto flotante (los enteros se convierten implícitamente a valores de tipo float)
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:
<metric name>{<label name>="<label value>", ...} == <value>. Cada componente del patrón de Prometheus (métrica, nombre de etiqueta, valor de etiqueta y valor de métrica) puede ser una macro de usuario.
8 salida de Prometheus siguiendo la sintaxis: <label name> (puede ser una macro de usuario) si label está seleccionado como segundo parámetro.
9 Una de las funciones de agregación: sum, min, max, avg, count si function está seleccionado como segundo parámetro.
10 Admite múltiples registros "Field name,OID prefix,Format" delimitados por un carácter de nueva línea.