En esta página
Objeto task
Los siguientes objetos están directamente relacionados con la API task.
Task
El objeto task tiene las siguientes propiedades:
| Property | Type | Description |
|---|---|---|
| taskid | ID | ID del task. Comportamiento de la propiedad: - solo lectura |
| type | integer | Tipo del task. Valores posibles: 1 - Información de diagnóstico; 2 - Actualizar la configuración del proxy; 6 - Ejecutar ahora. Desde Zabbix 7.4.3, los usuarios de tipo Admin y User pueden crear tasks de tipo 'Ejecutar ahora'. Tenga en cuenta que task.get siempre devuelve "7" (resumen de ejecución del task).Comportamiento de la propiedad: - obligatorio |
| status | integer | Estado del task. Valores posibles: 1 - nuevo task; 2 - task en progreso; 3 - task completado; 4 - task caducado. Comportamiento de la propiedad: - solo lectura |
| clock | timestamp | Hora en que se creó el task. Comportamiento de la propiedad: - solo lectura |
| ttl | integer | Tiempo en segundos tras el cual el task caduca. Comportamiento de la propiedad: - solo lectura |
| proxyid | ID | ID del proxy sobre el que se recopila la información estadística de diagnóstico. Comportamiento de la propiedad: - compatible si type está establecido en "Información de diagnóstico" o "Actualizar la configuración del proxy" |
| request | object | Objeto de solicitud del task según el tipo de task: El objeto del task 'Ejecutar ahora' se describe en detalle a continuación; El objeto del task 'Actualizar la configuración del proxy' se describe en detalle a continuación; El objeto del task 'Información de diagnóstico' se describe en detalle a continuación. Comportamiento de la propiedad: - obligatorio |
| result | object | Objeto de resultado del task de información de diagnóstico. Puede contener NULL si el resultado aún no está listo. El objeto de resultado se describe en detalle a continuación. Comportamiento de la propiedad: - solo lectura |
Objeto de solicitud 'Execute now'
El objeto de solicitud de tarea 'Execute now' tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID de item y reglas de descubrimiento de bajo nivel. Desde Zabbix 7.4.3, los usuarios de tipo Admin y User pueden ejecutar 'Execute now' en items de hosts para los que tengan permiso de lectura y escritura, o permiso de lectura y la acción invoke_execute_now action habilitada para su rol. Lo mismo se aplica a los usuarios de tipo Admin para las reglas de descubrimiento de bajo nivel (LLD). |
Objeto de solicitud 'Actualizar configuración del proxy'
El objeto de solicitud de la tarea 'Actualizar configuración del proxy' tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| proxyids | array | IDs de proxy. |
Objeto de solicitud de 'Información de diagnóstico'
El objeto de solicitud de tarea de información de diagnóstico tiene las siguientes propiedades. El objeto de solicitud de estadísticas para todos los tipos de propiedades se describe en detalle más abajo.
| Propiedad | Tipo | Descripción |
|---|---|---|
| historycache | object | Solicitud de estadísticas de la caché de histórico. Disponible en server y proxy. |
| valuecache | object | Solicitud de estadísticas de la caché de items. Disponible en server. |
| preprocessing | object | Solicitud de estadísticas del gestor de preprocesamiento. Disponible en server y proxy. |
| alerting | object | Solicitud de estadísticas del gestor de alertas. Disponible en server. |
| lld | object | Solicitud de estadísticas del gestor de LLD. Disponible en server. |
Objeto de solicitud de estadísticas
El objeto de solicitud de estadísticas se utiliza para definir qué tipo de información debe recopilarse sobre los procesos internos del server/proxy. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| stats | query | Propiedades del objeto de estadísticas que se devolverán. La lista de campos disponibles para cada tipo de información estadística de diagnóstico se describe en detalle a continuación. Por defecto: extend devolverá todos los campos estadísticos disponibles. |
| top | object | Objeto para ordenar y limitar los valores estadísticos devueltos. La lista de campos disponibles para cada tipo de información estadística de diagnóstico se describe en detalle a continuación. Ejemplo: { “source.alerts”: 10 } |
Lista de campos estadísticos disponibles para cada tipo de solicitud de información de diagnóstico
Se pueden solicitar los siguientes campos estadísticos para cada tipo de propiedad de solicitud de información de diagnóstico.
| Tipo de diagnóstico | Campos disponibles | Descripción |
|---|---|---|
| historycache | items | Número de métricas en caché. |
| values | Número de valores en caché. | |
| memory | Estadísticas de memoria compartida (espacio libre, número de fragmentos usados, número de fragmentos libres, tamaño máximo del fragmento libre). | |
| memory.data | Estadísticas de memoria compartida de la caché de datos históricos. | |
| memory.index | Estadísticas de memoria compartida de la caché de índices históricos. | |
| valuecache | items | Número de métricas en caché. |
| values | Número de valores en caché. | |
| memory | Estadísticas de memoria compartida (espacio libre, número de fragmentos usados, número de fragmentos libres, tamaño máximo del fragmento libre). | |
| mode | Modo de caché de valores. | |
| preprocessing | values | Número de valores en cola. |
| preproc.values | Número de valores en cola con pasos de preprocesamiento. | |
| alerting | alerts | Número de alertas en cola. |
| lld | rules | Número de reglas en cola. |
| values | Número de valores en cola. |
Lista de campos de ordenación disponibles para cada tipo de solicitud de información de diagnóstico
Se pueden utilizar los siguientes campos estadísticos para ordenar y limitar la información solicitada.
| Tipo de diagnóstico | Campos disponibles | Tipo |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
Objeto de resultado estadístico
El objeto de resultado estadístico se recupera en el campo result del objeto de tarea.
| Propiedad | Tipo | Descripción |
|---|---|---|
| status | integer | Estado del resultado de la tarea. Valores posibles: -1 - se produjo un error durante la ejecución de la tarea; 0 - el resultado de la tarea se ha creado. Comportamiento de la propiedad: - sólo lectura |
| data | string/object | Resultados según el objeto de solicitud estadística de una tarea de información de diagnóstico concreta. Contiene el mensaje de error si se produjo un error durante la ejecución de la tarea. |