On this page
Obiekt Correlation =
Następujące obiekty są bezpośrednio powiązane z API correlation.
Korelacja
Obiekt korelacji ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| correlationid | ID | ID korelacji. Zachowanie właściwości: - tylko do odczytu - wymagane dla operacji aktualizacji |
| name | string | Nazwa korelacji. Zachowanie właściwości: - wymagane dla operacji tworzenia |
| description | string | Opis korelacji. |
| status | integer | Określa, czy korelacja jest włączona czy wyłączona. Możliwe wartości: 0 - (domyślnie) włączona; 1 - wyłączona. |
Operacja korelacji
Obiekt operacji korelacji definiuje operację, która zostanie wykonana po uruchomieniu korelacji. Ma następujące właściwości.
| Właściwość | Type | Opis |
|---|---|---|
| type | integer | Typ operacji. Możliwe wartości: 0 - zamknij stare zdarzenia; 1 - zamknij nowe zdarzenie. Zachowanie właściwości: - wymagane |
Filtr korelacji
Obiekt filtra korelacji definiuje zestaw warunków, które muszą zostać spełnione, aby wykonać skonfigurowane operacje korelacji. Ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| conditions | array | Zestaw warunków filtra używanych do filtrowania wyników. Warunki zostaną posortowane zgodnie z kolejnością ich występowania w formule. Zachowanie właściwości: - wymagane |
| evaltype | integer | Metoda oceny warunków filtra. Możliwe wartości: 0 - And/Or; 1 - And; 2 - Or; 3 - Wyrażenie niestandardowe. Zachowanie właściwości: - wymagane |
| eval_formula | string | Wygenerowane wyrażenie, które będzie używane do oceny warunków filtra. Wyrażenie zawiera identyfikatory odnoszące się do określonych warunków filtra za pomocą ich formulaid. Wartość eval_formula jest równa wartości formula dla filtrów z wyrażeniem niestandardowym.Zachowanie właściwości: - tylko do odczytu |
| formula | string | Wyrażenie zdefiniowane przez użytkownika, używane do oceny warunków filtrów z wyrażeniem niestandardowym. Wyrażenie musi zawierać identyfikatory odnoszące się do określonych warunków filtra za pomocą ich formulaid. Identyfikatory użyte w wyrażeniu muszą dokładnie odpowiadać tym zdefiniowanym w warunkach filtra: żaden warunek nie może pozostać nieużyty ani pominięty.Zachowanie właściwości: - wymagane, jeśli evaltype jest ustawione na „custom expression” |
Warunek filtra korelacji
Obiekt warunku filtra korelacji definiuje określony warunek, który musi zostać sprawdzony przed uruchomieniem operacji korelacji.
| Property | Type | Description |
|---|---|---|
| type | integer | Typ warunku. Możliwe wartości: 0 - tag starego zdarzenia; 1 - tag nowego zdarzenia; 2 - grupa hostów nowego zdarzenia; 3 - para tagów zdarzenia; 4 - wartość tagu starego zdarzenia; 5 - wartość tagu nowego zdarzenia. Zachowanie właściwości: - wymagane |
| tag | string | Tag zdarzenia (starego lub nowego). Zachowanie właściwości: - wymagane, jeśli type jest ustawione na „tag starego zdarzenia”, „tag nowego zdarzenia”, „wartość tagu starego zdarzenia” lub „wartość tagu nowego zdarzenia” |
| groupid | ID | ID grupy hostów. Zachowanie właściwości: - wymagane, jeśli type jest ustawione na „grupa hostów nowego zdarzenia” |
| oldtag | string | Tag starego zdarzenia. Zachowanie właściwości: - wymagane, jeśli type jest ustawione na „para tagów zdarzenia” |
| newtag | string | Tag starego zdarzenia. Zachowanie właściwości: - wymagane, jeśli type jest ustawione na „para tagów zdarzenia” |
| value | string | Wartość tagu zdarzenia (starego lub nowego). Zachowanie właściwości: - wymagane, jeśli type jest ustawione na „wartość tagu starego zdarzenia” lub „wartość tagu nowego zdarzenia” |
| formulaid | string | Dowolny unikalny identyfikator używany do odwoływania się do warunku z wyrażenia niestandardowego. Może zawierać wyłącznie wielkie litery. Identyfikator musi zostać zdefiniowany przez użytkownika podczas modyfikowania warunków filtra, ale zostanie wygenerowany ponownie przy późniejszym żądaniu ich pobrania. |
| operator | integer | Operator warunku. Zachowanie właściwości: - wymagane, jeśli type jest ustawione na „grupa hostów nowego zdarzenia”, „wartość tagu starego zdarzenia” lub „wartość tagu nowego zdarzenia” |
Aby lepiej zrozumieć, jak używać filtrów z różnymi typami wyrażeń, zobacz przykłady na stronach metod correlation.get i correlation.create.
Dla każdego typu warunku obsługiwane są następujące operatory i wartości.
| Condition | Condition name | Supported operators | Expected value |
|---|---|---|---|
| 2 | Grupa hostów | =, <> | ID grupy hostów. |
| 4 | Wartość tagu starego zdarzenia | =, <>, like, not like | string |
| 5 | Wartość tagu nowego zdarzenia | =, <>, like, not like | string |