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 żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
alertids ID/array Zwraca tylko alerty o podanych identyfikatorach.
actionids ID/array Zwraca tylko alerty wygenerowane przez podane akcje.
eventids ID/array Zwraca tylko alerty wygenerowane przez podane zdarzenia.
groupids ID/array Zwraca tylko alerty wygenerowane przez obiekty z podanych grup hostów.
hostids ID/array Zwraca tylko alerty wygenerowane przez obiekty z podanych hostów.
mediatypeids ID/array Zwraca tylko alerty wiadomości, w których użyto podanych typów mediów.
objectids ID/array Zwraca tylko alerty wygenerowane przez podane obiekty
userids ID/array Zwraca tylko alerty wiadomości, które zostały wysłane do podanych użytkowników.
eventobject integer Zwraca tylko alerty wygenerowane przez zdarzenia powiązane z obiektami podanego typu.

Listę obsługiwanych typów obiektów można znaleźć w object zdarzenia.

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

Listę obsługiwanych typów zdarzeń można znaleźć w source zdarzenia.

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

Ograniczenia zależne od typu użytkownika można znaleźć w mediatype.get.
selectUsers query Zwraca właściwość users z tablicą użytkowników, do których była adresowana wiadomość.

Ograniczenia zależne od typu użytkownika można znaleźć w user.get.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Parametry te 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

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 na serwerze Linux jest niedostępny przez 5 minut: ",
            "message": "Wyzwalacz: Zabbix agent na serwerze Linux jest niedostępny przez 5 minut: \nStan wyzwalacza: PROBLEM\nWażność wyzwalacza: Niesklasyfikowane",
            "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.