Documentation
Table of Contents
> Service object
Poniższe obiekty są bezpośrednio powiązane z interfejsem API service.
Service
Obiekt service posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| serviceid | string | (tylko do odczytu) ID usługi. |
| algorithm (wymagane) |
integer | Reguła obliczania stanu. Dotyczy tylko wtedy, gdy istnieją usługi podrzędne. Możliwe wartości: 0 - ustaw status na OK; 1 - wybierz najbardziej krytyczny, jeśli wszystkie usługi podrzędne mają problemy; 2 - wybierz najbardziej krytyczny spośród usług podrzędnych. |
| name (wymagane) |
string | Nazwa usługi. |
| sortorder (wymagane) |
integer | Pozycja usługi używana do sortowania. Możliwe wartości: 0-999. |
| weight | integer | Waga usługi. Możliwe wartości: 0-1000000. Domyślnie: 0. |
| propagation_rule | integer | Reguła propagacji stanu. Musi być ustawiona razem z propagation_value.Możliwe wartości: 0 - (domyślne) propaguj stan usługi bez zmian; 1 - zwiększ propagowany stan o określoną propagation_value (o 1 do 5 poziomów);2 - zmniejsz propagowany stan o określoną propagation_value (o 1 do 5 poziomów);3 - ignoruj tę usługę - stan nie jest propagowany do usługi nadrzędnej w ogóle; 4 - ustaw stały stan usługi za pomocą określonej propagation_value. |
| propagation_value | integer | Wartość propagacji stanu. Musi być ustawiona razem z propagation_rule.Możliwe wartości dla propagation_rule o wartościach 0 i 3: 0.Możliwe wartości dla propagation_rule o wartościach 1 i 2: 1-5.Możliwe wartości dla propagation_rule o wartości 4:-1 - OK; 0 - Nie sklasyfikowany; 1 - Informacja; 2 - Ostrzeżenie; 3 - Średni; 4 - Wysoki; 5 - Katastrofa. |
| status | integer | (tylko do odczytu) Czy usługa znajduje się w stanie OK lub problemu. Jeśli usługa znajduje się w stanie problemu, status jest równy:- poziomie najbardziej krytycznego problemu; - najwyższemu statusowi usługi podrzędnej w stanie problemu. Jeśli usługa znajduje się w stanie OK, status jest równy -1. |
| description | string | Opis usługi. |
| uuid | string | Uniwersalny identyfikator unikalny. W przypadku operacji aktualizacji to pole jest tylko do odczytu. |
| created_at | integer | Znacznik czasu Unix, kiedy usługa została utworzona. |
| readonly | boolean | (tylko do odczytu) Dostęp do usługi. Możliwe wartości: 0 - Do zapisu; 1 - Do odczytu. |
Należy zauważyć, że dla niektórych metod (aktualizacja, usunięcie) kombinacja parametrów wymaganych/opcjonalnych jest inna.
Status rule
Obiekt status rule posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Warunek ustawienia nowego stanu (New status). Możliwe wartości: 0 - jeśli co najmniej (N) usług podrzędnych ma status (Stan) lub wyższy; 1 - jeśli co najmniej (N%) usług podrzędnych ma status (Stan) lub wyższy; 2 - jeśli mniej niż (N) usług podrzędnych ma status (Stan) lub niższy; 3 - jeśli mniej niż (N%) usług podrzędnych ma status (Stan) lub niższy; 4 - jeśli waga usług podrzędnych z (Stan) lub wyższym wynosi co najmniej (W); 5 - jeśli waga usług podrzędnych z (Stan) lub wyższym wynosi co najmniej (N%); 6 - jeśli waga usług podrzędnych z (Stan) lub niższym jest mniejsza niż (W); 7 - jeśli waga usług podrzędnych z (Stan) lub niższym jest mniejsza niż (N%). Gdzie: - N (W) to limit_value;- (Stan) to limit_status;- (New status) to new_status. |
| limit_value (wymagane) |
integer | Wartość limitu. Możliwe wartości: - dla N i W: 1-100000; - dla N%: 1-100. |
| limit_status (wymagane) |
integer | Limit statusu. Możliwe wartości: -1 - OK; 0 - Nie sklasyfikowany; 1 - Informacja; 2 - Ostrzeżenie; 3 - Średni; 4 - Wysoki; 5 - Katastrofa. |
| new_status (wymagane) |
integer | Nowa wartość statusu. Możliwe wartości: 0 - Nie sklasyfikowany; 1 - Informacja; 2 - Ostrzeżenie; 3 - Średni; 4 - Wysoki; 5 - Katastrofa. |
Service tag
Obiekt service tag ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika usługi. |
| value | string | Wartość znacznika usługi. |
Service alarm
Alarmy usługi nie mogą być bezpośrednio tworzone, aktualizowane ani usuwane za pomocą interfejsu API Zabbix.
Obiekty alarmów usługi reprezentują zmianę stanu usługi. Posiadają one następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| clock | timestamp | Czas, kiedy nastąpiła zmiana stanu usługi. |
| value | integer | Stan usługi. Sprawdź właściwości stanu usługi po listę możliwych wartości. |
Problem tag
Znaczniki problemów pozwalają na powiązanie usług z zdarzeniami problemowymi. Obiekt problem tag posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika problemu. |
| operator | integer | Operator warunku mapowania. Możliwe wartości: 0 - (domyślne) równa się; 2 - zawiera. |
| value | string | Wartość znacznika problemu. |