Documentation
Table of Contents
Objeto de métrica
Los siguientes objetos están directamente relacionados con la API item.
Métrica
Las métricas de web no se pueden crear, modificar o borrar directamente mediante la API Zabbix.
El objeto de métrica tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| itemid | cadena | ID de la métrica. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| delay | cadena | Intervalo de actualización de la métrica. Acepta segundos o una unidad de tiempo con sufijo (30s,1m,2h,1d). Opcionalmente uno o más intervalos personalizados se pueden especificar como intervalos flexibles o programación. Varios intervalos están separados por un punto y coma. Se pueden utilizar macros de usuario. Una sola macro tiene que llenar todo el campo. No se admiten varias macros en un campo ni macros mezcladas con texto. Los intervalos flexibles se pueden escribir como dos macros separadas por una barra diagonal (por ejemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).<br >Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Agente Zabbix" (0), "Comprobación simple" (3), "Zabbix interno" (5), "Verificación externa" (10), "Monitor de base de datos" (11), "Agente IPMI" (12), "Agente SSH" (13), "Agente TELNET" (14), "Calculado" ( 15), "agente JMX" (16), "agente HTTP" (19), "agente SNMP" (20), "Script" (21), o si "tipo" está configurado en "agente Zabbix (activo)" ( 7) y key_ no contiene "mqtt.get" |
| hostid | cadena | ID del equipo o plantilla a la que pertenece la métrica. Comportamiento de la propiedad: - constante - obligatorio para operaciones de creación |
| interfaceid | cadena | ID de la interfaz de la métrica del equipo. Comportamiento de la propiedad: - obligatorio si la métrica pertenece al equipo y type está configurado en "agente Zabbix", "agente IPMI", "agente JMX", "Captura SNMP" o "agente SNMP"- compatible si el elemento pertenece al host y el tipo está configurado en "Simple check", "Comprobación externa", "Agente SSH", "Agente TELNET" o "Agente HTTP"- solo lectura para objetos descubiertos |
| key_ | cadena | Clave de la métrica. Comportamiento de la propiedad: - obligatorio para operaciones de creación - leer- sólo para objetos heredados u objetos descubiertos |
| name | cadena | Nombre de la métrica. Comportamiento de la propiedad: - obligatorio para operaciones de creación - leer- sólo para objetos heredados u objetos descubiertos |
| type | entero | Tipo de métrica. Valores posibles: 0 - Agente de Zabbix; 2 - Captura Zabbix; 3 - Comprobación simple; 5 - Interno de Zabbix ; 7 - Agente Zabbix (activo); 9 - Elemento web; 10 - Verificación externa; 11 - Monitor de base de datos; 12 - Agente IPMI; 13 - Agente SSH; 14 - Agente TELNET; 15 - Calculado; 16 - Agente JMX; 17 - Captura SNMP; 18 - Elemento dependiente; 19 - Agente HTTP;< br>20 - Agente SNMP; 21 - Script. Comportamiento de la propiedad: - obligatorio para las operaciones de creación - solo lectura para objetos heredados u objetos descubiertos |
| url | cadena | Cadena URL. Admite macros de usuario, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID} , {ITEM.KEY}. Comportamiento de la propiedad: - obligatorio si tipo está configurado como "agente HTTP"<br >- solo lectura para objetos heredados u objetos descubiertos |
| value_type | entero | Tipo de información del elemento. Valores posibles: 0 - número flotante; 1 - carácter; 2 - registro; 3 - numérico sin signo; 4 - texto. Comportamiento de la propiedad: - obligatorio para operaciones de creación - leer- sólo para objetos heredados u objetos descubiertos |
| allow_traps | entero | Permitir completar el valor de manera similar a la métrica de captura. 0 - (predeterminado) No permitir aceptar datos entrantes; 1 - Permitir aceptar datos entrantes.< br> Comportamiento de la propiedad: - compatible si type está configurado en "Agente HTTP"- solo lectura para objetos descubiertos |
| authtype | integer | Método de autenticación. Valores posibles si type está configurado en "Agente SSH":0 - contraseña (predeterminada); 1 - clave pública.<br > Valores posibles si tipo está configurado en "Agente HTTP":0 - (predeterminado) ninguno; 1 - básico; 2 - NTLM; 3 - Kerberos . Comportamiento de la propiedad: - compatible si type está configurado como "agente SSH" o "agente HTTP"- solo lectura para objetos heredados (si tipo está configurado en "agente HTTP") u objetos descubiertos |
| description | cadena | Descripción de la métrica. Comportamiento de la propiedad: - solo lectura para objetos descubiertos |
| error | cadena | Texto de error si hay problemas al actualizar la métrica. Comportamiento de la propiedad: - solo lectura |
| flags | entero | Origen de la métrica. Valores posibles: 0 - una métrica simple; 4 - una métrica descubierta. [Comportamiento de la propiedad](/manual /api/referencia |
Encabezado HTTP
El objeto de encabezado tiene las siguientes propiedades:
|Propiedad|Tipo|Descripción| |--------|---------------------------------------- -----------|-----------| |name|cadena|nombre del encabezado HTTP.
Comportamiento de la propiedad:
- obligatorio| |value|cadena|Valor del encabezado.
Comportamiento de la propiedad:
- obligatorio|
Campo de consulta HTTP
El objeto del campo de consulta define un nombre y un valor que se utiliza para especificar un parámetro de URL. Tiene las siguientes propiedades:
|Propiedad|Tipo|Descripción| |--------|---------------------------------------- -----------|-----------| |name|cadena|Nombre del parámetro.
Comportamiento de la propiedad:
- obligatorio| |value|cadena|Valor del parámetro.
Comportamiento de la propiedad:
- obligatorio|
Etiqueta de métrica
El objeto de etiqueta de métrica tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tag | cadena | Nombre de etiqueta de la métrica. Comportamiento de la propiedad: - obligatorio |
| value | cadena | Valor de etiqueta de la métrica. |
Preprocesamiento de métricas
El objeto de preprocesamiento de métricas tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | entero | El tipo de opción de preprocesamiento. Valores posibles: 1 - Multiplicador personalizado; 2 - Recorte derecho; 3 - Recorte izquierdo; 4 - Recorte; 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 - Dentro del rango; 14 - Coincide con la expresión regular; 15 - No coincide con la expresión regular; 16 - Comprobar errores en JSON; 17 - Comprobar errores en XML; 18 - Comprobar errores usando expresiones regulares; 19 - Descartar sin cambios; 20 - Descartar sin cambios con un latido; 21 - JavaScript; 22 - Patrón Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Reemplazar; 26 - Verificar no compatible; 27 - XML a JSON; 28 - Valor de caminata SNMP; 29 - Caminata SNMP a JSON. Comportamiento de la propiedad: - obligatorio |
| params | cadena | Parámetros adicionales utilizados por la opción de preprocesamiento. Varios parámetros están separados por el carácter de nueva línea (\n). Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Multiplicador personalizado" (1), "Recorte derecho" (2), "Recorte izquierdo" (3), "Recortar" (4), "Expresión regular " (5), "XML XPath" (11), "JSONPath" (12), "Dentro del rango" (13), "Coincide con la expresión regular" (14), "No coincide con la expresión regular" (15), "Verificar "Buscar errores en JSON" (16), "Verificar errores en XML" (17), "Verificar errores usando expresiones regulares" (18), "Descartar sin cambios con latido" (20), "JavaScript" (21), " Patrón de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Reemplazar" (25), "Valor de caminata SNMP" (28) o "Caminar SNMP a JSON" (29). ) |
| error_handler | 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; 1: descartar valor; 2 - Establecer un valor personalizado; 3 - Establecer un mensaje de error personalizado. Valores posibles si tipo está configurado en "Verificar no admitido":1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Multiplicador personalizado" (1), "Expresión regular" (5), "Booleano a decimal" (6), "Octal a decimal" (7), "Hexadecimal a decimal" (8), "Cambio simple" (9) , "Cambio por segundo" (10), "XML XPath" (11), "JSONPath" (12), "Dentro del rango" (13), "Coincide con la expresión regular" (14), "No coincide con la expresión regular" ( 15), "Verificar errores en JSON" (16), "Verificar errores en XML" (17), "Verificar errores usando expresiones regulares" (18), "Patrón de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Verificar no compatible" (26), "XML a JSON" (27), "Valor de recorrido SNMP" (28) o "Recorrido SNMP a JSON" (29) |
| error_handler_params | cadena | Parámetros del controlador de errores. Comportamiento de la propiedad: - obligatorio si error_handler está configurado en "Establecer valor personalizado" o "Establecer mensaje de error personalizado" |
Se admiten los siguientes parámetros y controladores de errores para 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 latidos|segundos5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Patrón de Prometheus|patrón6, 7|valor, etiqueta, función|salida8, 9|0, 1, 2, 3| |23|Prometheus 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| |28|Valor de caminata SNMP|OID2|Formato:
0 - Sin cambios
1 - UTF-8 de Hex-STRING
2 - MAC de Hex-STRING
3 - Entero de BITS |<|0, 1, 2, 3| |29|SNMP camina hacia JSON10|Nombre de campo2|Prefijo OID2|Formato:
0 - Sin cambios
1 - UTF-8 de Hex-STRING
2 - MAC de Hex-STRING
3 - Entero de BITS|0, 1, 2, 3|
1 número entero o de coma 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.
10 Admite múltiples registros de "Nombre de campo, prefijo OID, registros de formato" delimitados por un carácter de nueva línea.