Documentation
Table of Contents
> Objeto de correlación
Los siguientes objetos están directamente relacionados con la API de "correlación".
Correlación
El objeto de correlación tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| correlationid | string | (readonly) ID de la correlación. |
| nombre (obligatorio) |
cadena | Nombre de la correlación. |
| descripción | cadena | Descripción de la correlación. |
| status | número entero | Si la correlación está habilitada o deshabilitada. Los valores posibles son: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.
Operación de correlación
El objeto de operación de correlación define una operación que será realizada cuando se ejecuta una correlación. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tipo (obligatorio) |
número entero | Tipo de operación. Valores posibles: 0 - cerrar eventos antiguos; 1 - cerrar evento nuevo. |
Filtro de correlación
El objeto de filtro de correlación define un conjunto de condiciones que deben ser cumplidas para realizar las operaciones de correlación configuradas. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| evaltype (obligatorio) |
número entero | Método de evaluación de la condición del filtro. Valores posibles: 0 - y/o; 1 - y; 2 - o; 3 - expresión personalizada. |
| condiciones (obligatorio) |
matriz | Conjunto de condiciones de filtro a ser utilizado para filtrar resultados. |
| eval_formula | cadena | (readonly) Expresión generada que se utilizará para evaluar las condiciones del filtro. La expresión contiene IDs que hacen referencia a condiciones de filtro específicas mediante su "formulaid". El valor de eval_formula es igual al valor de formula para filtros con una expresión personalizada. |
| fórmula | cadena | Expresión definida por el usuario que se utilizará para evaluar las condiciones de los filtros con una expresión personalizada. La expresión debe contener IDs que hagan referencia a condiciones de filtro específicas mediante su "formulaid". Los IDs utilizados en la expresión deben coincidir exactamente con los definidos en las condiciones del filtro: ninguna condición puede permanecer sin uso u omitida. Obligatorio para filtros de expresión personalizados. |
Condición del filtro de correlación
El objeto de condición del filtro de correlación define una condición específica que debe comprobarse antes de ejecutar las operaciones de correlación.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tipo (obligatorio) |
número entero | Tipo de condición. Valores posibles: 0 - etiqueta de evento anterior; 1 - etiqueta de evento nueva; 2 - nuevo grupo de hosts de eventos; 3 - par de etiquetas de eventos; 4 - valor de etiqueta de evento anterior; 5 - nuevo valor de etiqueta de evento. |
| etiqueta | cadena | Etiqueta de evento (antigua o nueva). Requerido cuando el tipo de condición es: 0, 1, 4, 5. |
| groupid | cadena | ID del grupo de host. Requerido cuando el tipo de condición es: 2. |
| oldtag | cadena | Etiqueta de evento antigua. Requerido cuando el tipo de condición es: 3. |
| newtag | cadena | Nueva etiqueta de evento. Requerido cuando el tipo de condición es: 3. |
| valor | cadena | Valor de etiqueta de evento (antiguo o nuevo). Requerido cuando el tipo de condición es: 4, 5. |
| formulaid | cadena | ID único arbitrario que se utiliza para hacer referencia a la condición desde una expresión personalizada. Sólo puede contener letras mayúsculas. El ID debe ser definido por el usuario al modificar las condiciones del filtro, pero se generará nuevamente al solicitarlas posteriormente. |
| operador | número entero | Operador de condición. Obligatorio cuando el tipo de condición es: 2, 4, 5. |
Para comprender mejor cómo utilizar filtros con varios tipos de expresiones, ver ejemplos en el correlation.get y correlation.create páginas de método
Los siguientes operadores y valores son compatibles con cada condición. tipo.
|Condición|Nombre de la condición|Operadores admitidos|Valor esperado| |---------|--------------|-------------------|---- ----------| |2|Grupo de hosts|=, <>|ID del grupo de hosts.| |4|Valor de etiqueta de evento anterior|=, <>, me gusta, no me gusta|cadena| |5|Nuevo valor de etiqueta de evento|=, <>, me gusta, no me gusta|cadena|