Obiekt task
Następujące obiekty są bezpośrednio powiązane z API task.
Task
Obiekt task ma następujące właściwości:
| Property | Type | Description |
|---|---|---|
| taskid | ID | ID zadania. Zachowanie właściwości: - tylko do odczytu |
| type | integer | Typ zadania. Możliwe wartości: 1 - Informacje diagnostyczne; 2 - Odśwież konfigurację proxy; 6 - Wykonaj teraz. Użytkownicy typu Admin i User mogą tworzyć tylko zadania „Wykonaj teraz”. Zwróć uwagę, że task.get zawsze zwraca „7” (Podsumowanie wykonania zadania).Zachowanie właściwości: - wymagane |
| status | integer | Status zadania. Możliwe wartości: 1 - nowe zadanie; 2 - zadanie w toku; 3 - zadanie ukończone; 4 - zadanie wygasło. Zachowanie właściwości: - tylko do odczytu |
| clock | timestamp | Czas utworzenia zadania. Zachowanie właściwości: - tylko do odczytu |
| ttl | integer | Czas w sekundach, po którym zadanie wygasa. Zachowanie właściwości: - tylko do odczytu |
| proxyid | ID | ID proxy, dla którego zbierane są statystyki informacji diagnostycznych. Zachowanie właściwości: - obsługiwane, jeśli type jest ustawione na „Informacje diagnostyczne” lub „Odśwież konfigurację proxy” |
| request | object | Obiekt żądania zadania zgodnie z typem zadania: Obiekt zadania „Wykonaj teraz” jest opisany szczegółowo poniżej; Obiekt zadania „Odśwież konfigurację proxy” jest opisany szczegółowo poniżej; Obiekt zadania „Informacje diagnostyczne” jest opisany szczegółowo poniżej. Zachowanie właściwości: - wymagane |
| result | object | Obiekt wyniku zadania informacji diagnostycznych. Może zawierać NULL, jeśli wynik nie jest jeszcze gotowy. Obiekt wyniku jest opisany szczegółowo poniżej. Zachowanie właściwości: - tylko do odczytu |
Obiekt żądania „Execute now”
Obiekt żądania zadania „Execute now” ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| itemid | ID | ID pozycji i reguł wykrywania niskiego poziomu. Użytkownicy typu Admin i User mogą wykonać „Execute now” dla pozycji na hostach, do których mają uprawnienie odczytu i zapisu (read-write) albo uprawnienie read oraz włączoną akcję invoke_execute_now action dla swojej roli. To samo dotyczy użytkowników typu Admin w przypadku reguł wykrywania niskiego poziomu (LLD). |
Obiekt żądania „Refresh proxy configuration”
Obiekt żądania zadania „Refresh proxy configuration” ma następujące właściwości.
| Właściwość | Type | Opis |
|---|---|---|
| proxyids | array | ID proxy. |
Obiekt żądania „Diagnostic information”
Obiekt żądania zadania informacji diagnostycznych ma następujące właściwości. Obiekt żądania statystyk dla wszystkich typów właściwości jest opisany szczegółowo poniżej.
| Właściwość | Typ | Opis |
|---|---|---|
| historycache | object | Żądanie statystyk pamięci podręcznej historii. Dostępne na serwer i proxy. |
| valuecache | object | Żądanie statystyk pamięci podręcznej pozycji. Dostępne na serwer. |
| preprocessing | object | Żądanie statystyk menedżera przetwarzania wstępnego. Dostępne na serwer i proxy. |
| alerting | object | Żądanie statystyk menedżera alertów. Dostępne na serwer. |
| lld | object | Żądanie statystyk menedżera LLD. Dostępne na serwer. |
Obiekt żądania statystyk
Obiekt żądania statystyk służy do określenia, jaki typ informacji powinien być zbierany o wewnętrznych procesach serwera/proxy. Ma on następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| stats | query | Właściwości obiektu statystyk, które mają zostać zwrócone. Lista dostępnych pól dla każdego typu statystyk informacji diagnostycznych jest opisana szczegółowo poniżej. Domyślnie: extend zwróci wszystkie dostępne pola statystyk. |
| top | object | Obiekt służący do sortowania i ograniczania zwracanych wartości statystyk. Lista dostępnych pól dla każdego typu statystyk informacji diagnostycznych jest opisana szczegółowo poniżej. Przykład: { “source.alerts”: 10 } |
Lista pól statystyk dostępnych dla każdego typu żądania informacji diagnostycznych
Dla każdej właściwości typu żądania informacji diagnostycznych można żądać następujących pól statystyk.
| Typ diagnostyczny | Dostępne pola | Opis |
|---|---|---|
| historycache | items | Liczba elementów w pamięci podręcznej. |
| values | Liczba wartości w pamięci podręcznej. | |
| memory | Statystyki pamięci współdzielonej (wolne miejsce, liczba używanych fragmentów, liczba wolnych fragmentów, maksymalny rozmiar wolnego fragmentu). | |
| memory.data | Statystyki pamięci współdzielonej pamięci podręcznej danych historii. | |
| memory.index | Statystyki pamięci współdzielonej pamięci podręcznej indeksu historii. | |
| valuecache | items | Liczba elementów w pamięci podręcznej. |
| values | Liczba wartości w pamięci podręcznej. | |
| memory | Statystyki pamięci współdzielonej (wolne miejsce, liczba używanych fragmentów, liczba wolnych fragmentów, maksymalny rozmiar wolnego fragmentu). | |
| mode | Tryb pamięci podręcznej wartości. | |
| preprocessing | values | Liczba wartości w kolejce. |
| preproc.values | Liczba wartości w kolejce z krokami przetwarzania wstępnego. | |
| alerting | alerts | Liczba alertów w kolejce. |
| lld | rules | Liczba reguł w kolejce. |
| values | Liczba wartości w kolejce. |
Lista pól sortowania dostępnych dla każdego typu żądania informacji diagnostycznych
Następujące pola statystyczne mogą być używane do sortowania i ograniczania żądanych informacji.
| Typ diagnostyczny | Dostępne pola | Typ |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
Obiekt wyniku statystyk
Obiekt wyniku statystyk jest pobierany w polu result obiektu zadania.
| Właściwość | Typ | Opis |
|---|---|---|
| status | integer | Status wyniku zadania. Możliwe wartości: -1 - podczas wykonywania zadania wystąpił błąd; 0 - wynik zadania został utworzony. Zachowanie właściwości: - tylko do odczytu |
| data | string/object | Wyniki zgodne z obiektem żądania statystyk dla określonego zadania informacji diagnostycznych. Zawiera ciąg komunikatu o błędzie, jeśli podczas wykonywania zadania wystąpił błąd. |