Documentation
Table of Contents
> Obiekt Correlation =
Następujące obiekty są bezpośrednio powiązane z API correlation.
Correlation
Obiekt correlation posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| correlationid | string | (tylko do odczytu) Identyfikator korelacji. |
| name (wymagane) |
string | Nazwa korelacji. |
| description | string | Opis korelacji. |
| status | integer | Czy korelacja jest włączona czy wyłączona. Możliwe wartości to: 0 - (domyślnie) włączona; 1 - wyłączona. |
Należy zauważyć, że w przypadku niektórych metod (update, delete) wymagana/opcjonalna kombinacja parametrów jest inna.
Correlation operation
Obiekt correlation operation definiuje operację, która będzie wykonana, kiedy wykonywana jest korelacja. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Typ operacji. Możliwe wartości: 0 - zamknij stare zdarzenia; 1 - zamknij nowe zdarzenia. |
Correlation filter
Obiekt correlation filter definiuje zestaw warunków, które musza być spełnione, aby wykonać skonfigurowane operacje korelacji. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| evaltype (wymagane) |
integer | Metoda oceny warunków filtra. Możliwe wartości: 0 - i/lub; 1 - i; 2 - lub; 3 - wyrażenie niestandardowe. |
| conditions (wymagane) |
array | Zestaw warunków filtrowania używnych do filtrowania wyników. |
| eval_formula | string | (tylko do odczytu) Wygenerowane wyrażenie, które zostanie użyte do oceny warunków filtra. Wyrażenie zawiera identyfikatory, które odwołują się do określonych warunków filtru za pomocą formulaid. Wartość eval_formula jest równa wartości formula dla filtrów z wyrażeniem niestandardowym. |
| formula | string | Zdefiniowane przez użytkownika wyrażenie do oceny warunków filtrów za pomocą wyrażenia niestandardowego.. Wyrażenie musi zawierać identyfikatory, które odwołują się do określonych warunków filtru za pomocą „formulaid”. Identyfikatory użyte w wyrażeniu muszą dokładnie odpowiadać identyfikatorom zdefiniowanym w warunkach filtra: żaden warunek nie może pozostać nieużywany ani pominięty. Wymagany w przypadku filtrów wyrażeń niestandardowych. |
Correlation filter condition
Obiekt correlation filter condition definiuje określony warunek, który należy sprawdzić przed uruchomieniem operacji korelacji.
| Właściwość | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Typ warunku. Możliwe wartości: 0 - stary znacznik zdarzenia; 1 - nowy znacznik zdarzenia; 2 - nowa grupa hostów zdarzenia; 3 - para znaczników zdarzeń; 4 - stara wartość znacznika zdarzenia; 5 - nowa wartość znacznika zdarzenia. |
| tag | string | Znacznik zdarzenia (stary lub nowy). Wymagane, gdy typ warunku to: 0, 1, 4, 5. |
| groupid | string | OD grupy hosta. Wymagane, gdy typ warunku to: 2. |
| oldtag | string | Stary tag zdarzenia. Wymagane, gdy typ warunku to: 3. |
| newtag | string | Nowy tag zdarzenia. Wymagane, gdy typ warunku to: 3. |
| value | string | Wartość tagu zdarzenia (stara lub nowa). Wymagane, gdy typ warunku to: 4, 5. |
| formulaid | string | Dowolny unikalny ID używany do odniesienia się do warunku z wyrażenia niestandardowego. Może zawierać tylko wielkie litery. Identyfikator musi zostać zdefiniowany przez użytkownika podczas modyfikowania warunków filtrowania, ale zostanie wygenerowany ponownie, gdy zażąda tego później. |
| operator | integerOperator warunku. Wymagane, gdy typ warunku to: 2, 4, 5. |
Aby lepiej zrozumieć, jak używać filtrów z różnymi typami wyrażeń, zobacz przykłady na stronach metod correlation.get oraz correlation.create.
Następujące operatory i wartości są obsługiwane dla każdego typu warunku.
| Warunek | Nazwa warunku | Obsługiwane operatory | Wartość oczekiwana |
|---|---|---|---|
| 2 | Grupa hosta | =, <> | ID grupy hosta. |
| 4 | Stara wartość znacznika zdarzenia | =, <>, like, not like | string |
| 5 | Nowa wartość znacznika zdarzenia | =, <>, like, not like | string |