Table of Contents
Objeto correlation
Os seguintes objetos estão diretamente relacionados à API correlation.
Correlação
O objeto de correlação possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| correlationid | ID | ID da correlação. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| name | string | Nome da correlação. Comportamento da propriedade: - obrigatório para operações de criação |
| description | string | Descrição da correlação. |
| status | integer | Se a correlação está habilitada ou desabilitada. Valores possíveis: 0 - (padrão) habilitada; 1 - desabilitada. |
Operação de correlação
O objeto de operação de correlação define uma operação que será executada quando uma correlação for executada. Ele possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | integer | Tipo de operação. Valores possíveis: 0 - fechar eventos antigos; 1 - fechar novo evento. Comportamento da propriedade: - obrigatório |
Filtro de correlação
O objeto de filtro de correlação define um conjunto de condições que devem ser atendidas para executar as operações de correlação configuradas. Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| conditions | array | Conjunto de condições de filtro a serem usadas para filtrar resultados. As condições serão classificadas na ordem de sua colocação na fórmula. Comportamento da propriedade: - obrigatório |
| evaltype | integer | Método de avaliação da condição de filtro. Valores possíveis: 0 - e/ou; 1 - e; 2 - ou; 3 - expressão personalizada. Comportamento da propriedade: - obrigatório |
| eval_formula | string | Expressão gerada que será usada para avaliar as condições do filtro. A expressão contém IDs que referenciam condições de filtro específicas por seu formulaid. O valor de eval_formula é igual ao valor de formula para filtros com uma expressão personalizada.Comportamento da propriedade: - somente leitura |
| formula | string | Expressão definida pelo usuário a ser usada para avaliar as condições de filtros com uma expressão personalizada. A expressão deve conter IDs que referenciem condições de filtro específicas por seu formulaid. Os IDs usados na expressão devem corresponder exatamente aos definidos nas condições do filtro: nenhuma condição pode permanecer não utilizada ou omitida.Comportamento da propriedade: - obrigatório se evaltype estiver definido como "expressão personalizada" |
Condição do filtro de correlação
O objeto de condição do filtro de correlação define uma condição específica que deve ser verificada antes de executar as operações de correlação.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | integer | Tipo de condição. Valores possíveis: 0 - tag de evento antigo; 1 - tag de evento novo; 2 - grupo de hosts do novo evento; 3 - par de tags de evento; 4 - valor da tag de evento antigo; 5 - valor da tag de evento novo. Comportamento da propriedade: - obrigatório |
| tag | string | Tag do evento (antiga ou nova). Comportamento da propriedade: - obrigatório se type for definido como "tag de evento antigo", "tag de evento novo", "valor da tag de evento antigo" ou "valor da tag de evento novo" |
| groupid | ID | ID do grupo de hosts. Comportamento da propriedade: - obrigatório se type for definido como "grupo de hosts do novo evento" |
| oldtag | string | Tag do evento antigo. Comportamento da propriedade: - obrigatório se type for definido como "par de tags de evento" |
| newtag | string | Tag do evento antigo. Comportamento da propriedade: - obrigatório se type for definido como "par de tags de evento" |
| value | string | Valor da tag do evento (antiga ou nova). Comportamento da propriedade: - obrigatório se type for definido como "valor da tag de evento antigo" ou "valor da tag de evento novo" |
| formulaid | string | ID único arbitrário que é usado para referenciar a condição a partir de uma expressão personalizada. Só pode conter letras maiúsculas. O ID deve ser definido pelo usuário ao modificar as condições do filtro, mas será gerado novamente ao solicitá-las posteriormente. |
| operator | integer | Operador da condição. Comportamento da propriedade: - obrigatório se type for definido como "grupo de hosts do novo evento", "valor da tag de evento antigo" ou "valor da tag de evento novo" |
Para entender melhor como usar filtros com vários tipos de expressões, consulte exemplos nas páginas dos métodos correlation.get e correlation.create.
Os seguintes operadores e valores são suportados para cada tipo de condição.
| Condição | Nome da condição | Operadores suportados | Valor esperado |
|---|---|---|---|
| 2 | Grupo de hosts | =, <> | ID do grupo de hosts. |
| 4 | Valor da tag de evento antigo | =, <>, like, not like | string |
| 5 | Valor da tag de evento novo | =, <>, like, not like | string |