alert.get

Opis

integer/array alert.get(object parameters)

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

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.

Parameters

(object) Parametry definiujące pożądane wyjście.

Metoda wspiera następujące parametry.

Parametr Typ Opis
alertids string/array Zwraca wyłącznie alarmy z podanym identyfikatorem ID.
actionids string/array Zwraca wyłącznie alarmy utworzone przez podane akcje.
eventids string/array Zwraca wyłącznie alarmy utworzone przez podane zdarzenia.
groupids string/array Zwraca wyłącznie alarmy utworzone przez obiekty ze wskazanych grup hostów.
hostids string/array Zwraca wyłącznie alarmy utworzone przez obiekty ze wskazanych hostów.
mediatypeids string/array Zwraca wyłącznie treści alarmów użytych w podanych typach mediów.
objectids string/array Zwraca wyłącznie alarmy utworzone przez wskazane obiekty
userids string/array Zwraca wyłącznie treści alarmów wysłanych do wskazanych użytkowników.
eventobject integer Zwraca wyłącznie alarmy utworzone przez zdarzenia związane z obiektem wskazanego typu.

Patrz zdarzenie "object" aby uzyskać listę wspieranych typów zdarzeń.

Default: 0 - trigger.
eventsource integer Zwraca wyłącznie alarmy utworzone przez zdarzenia danego typu .

Patrz zdarzenie "source" aby uzyskać listę wspieranych typów zdarzeń.

Default: 0 - trigger events.
time_from timestamp Zwraca wyłącznie alarmy utworzone po wskazanym czasie.
time_till timestamp Zwraca wyłącznie alarmy utworzone przed wskazanym czasem.
selectHosts query Zwraca hosts własność z danymi hostów które uruchomiły operację akcji.
selectMediatypes query Zwraca mediatypes własność z tablicą typów mediów które zostały użyte w wiadomości alarmu.
selectUsers query Zwraca users własność z tablicą użytkowników do których wiadomość została
zaadresowana.
sortfield string/array Sortuje wynik po podanych własnościach.

Możliwe wartości to: alertid, clock, eventid, mediatypeid, sendto i status.
countOutput boolean Te parametry są wspólne dla wszystkich metod get opisanych w reference commentary.
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

Zwraca alarmy po identyfikatorze ID

Zwraca wszystkie alarmy utworzone przez akcję "3".

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: 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.