alert.get

Opis

integer/array alert.get(object parameters)

Metoda pozwala na pobieranie alertów zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w User roles.

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
alertids ID/array Zwracaj tylko alerty o podanych ID.
actionids ID/array Zwracaj tylko alerty wygenerowane przez podane akcje.
eventids ID/array Zwracaj tylko alerty wygenerowane przez podane zdarzenia.
groupids ID/array Zwracaj tylko alerty wygenerowane przez obiekty z podanych grup hostów.
hostids ID/array Zwracaj tylko alerty wygenerowane przez obiekty z podanych hostów.
mediatypeids ID/array Zwracaj tylko alerty wiadomości, które używały podanych typów mediów.
objectids ID/array Zwracaj tylko alerty wygenerowane przez podane obiekty
userids ID/array Zwracaj tylko alerty wiadomości wysłane do podanych użytkowników.
eventobject integer Zwracaj tylko alerty wygenerowane przez zdarzenia związane z obiektami danego typu.

Zobacz event object, aby uzyskać listę obsługiwanych typów obiektów.

Domyślnie: 0 - wyzwalacz.
eventsource integer Zwracaj tylko alerty wygenerowane przez zdarzenia danego typu.

Zobacz event source, aby uzyskać listę obsługiwanych typów zdarzeń.

Domyślnie: 0 - zdarzenia wyzwalacza.
time_from timestamp Zwracaj tylko alerty wygenerowane po podanym czasie.
time_till timestamp Zwracaj tylko alerty wygenerowane przed podanym czasem.
selectHosts query Zwracaj właściwość hosts z danymi hostów, które wywołały operację akcji.
selectMediatypes query Zwracaj właściwość mediatypes z tablicą typów mediów użytych dla alertu wiadomości.

Zobacz mediatype.get, aby poznać ograniczenia zależne od typu użytkownika.
selectUsers query Zwracaj właściwość users z tablicą użytkowników, do których była skierowana wiadomość.

Zobacz user.get, aby poznać ograniczenia zależne od typu użytkownika.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

W Zabbix 7.0.9 użytkownicy typu Admin i User mogą pobierać dane alertów typu "message" (0) tylko dotyczące własnego użytkownika.

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów albo;
  • liczbę zwracanych obiektów, jeśli parametr countOutput został użyty.

Przykłady

Pobieranie alertów według ID akcji

Pobierz wszystkie alerty wygenerowane przez akcję "3".

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "[email protected]",
            "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
            "message": "Wyzwalacz: Zabbix agent on Linux server is unreachable for 5 minutes: \nStatus wyzwalacza: PROBLEM\nWażność wyzwalacza: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}

Zobacz także

Źródło

CAlert::get() in ui/include/classes/api/services/CAlert.php.