event.acknowledge

Opis

object event.acknowledge(object/array parameters)

Ta metoda umożliwia aktualizację zdarzeń. Można wykonać następujące działania aktualizacyjne:

  • Zamknięcie zdarzenia. Jeśli zdarzenie jest już rozwiązane, to działanie zostanie pominięte.
  • Potwierdzenie zdarzenia. Jeśli zdarzenie jest już potwierdzone, to działanie zostanie pominięte.
  • Cofnięcie potwierdzenia zdarzenia. Jeśli zdarzenie nie jest potwierdzone, to działanie zostanie pominięte.
  • Dodanie wiadomości.
  • Zmiana ważności zdarzenia. Jeśli zdarzenie ma już tę samą ważność, to działanie zostanie pominięte.
  • Wyciszenie zdarzenia. Jeśli zdarzenie jest już wyciszone, to działanie zostanie pominięte.
  • Wyłączenie wyciszenia zdarzenia. Jeśli zdarzenie nie jest wyciszone, to działanie zostanie pominięte.
  • Zmiana rangi zdarzenia na przyczynę. Jeśli zdarzenie ma już rangę przyczyny, to działanie zostanie pominięte.
  • Zmiana rangi zdarzenia na symptom. Jeśli zdarzenie ma już rangę symptomu, to działanie zostanie pominięte.

Aktualizować można tylko zdarzenia wyzwalaczy.
Aktualizować można tylko zdarzenia problemów.
Aby zamknąć zdarzenie lub zmienić jego ważność, wymagane są uprawnienia odczytu/zapisu do wyzwalacza.
Aby zamknąć zdarzenie, w wyzwalaczu musi być dozwolone ręczne zamykanie.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania tej metody mogą zostać odebrane w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object/array) Parametry zawierające identyfikatory zdarzeń oraz operacje aktualizacji, które należy wykonać.

Parametr Type Opis
eventids ID/array Identyfikatory zdarzeń, które mają zostać potwierdzone.

Zachowanie parametru:
- wymagany
action integer Działanie(a) aktualizacji zdarzenia.

Możliwe wartości bitmapy:
1 - zamknij problem;
2 - potwierdź zdarzenie;
4 - dodaj wiadomość;
8 - zmień ważność;
16 - cofnij potwierdzenie zdarzenia;
32 - wycisz zdarzenie;
64 - wyłącz wyciszenie zdarzenia;
128 - zmień rangę zdarzenia na przyczynę;
256 - zmień rangę zdarzenia na symptom.

To pole jest maską bitową; akceptowana jest dowolna suma możliwych wartości bitmapy (na przykład 34 dla potwierdzenia i wyciszenia zdarzenia).

Zachowanie parametru:
- wymagany
cause_eventid ID Identyfikator zdarzenia będącego przyczyną.

Zachowanie parametru:
- wymagany, jeśli action zawiera bit „change event rank to symptom”
message string Treść wiadomości.

Zachowanie parametru:
- wymagany, jeśli action zawiera bit „add message”
severity integer Nowa ważność dla zdarzeń.

Możliwe wartości:
0 - niesklasyfikowane;
1 - informacja;
2 - ostrzeżenie;
3 - średni;
4 - wysoki;
5 - katastrofa.

Zachowanie parametru:
- wymagany, jeśli action zawiera bit „change severity”
suppress_until integer Znacznik czasu Unix, do którego zdarzenie ma być wyciszone.

Jeśli ustawiono wartość „0”, wyciszenie będzie bezterminowe.

Zachowanie parametru:
- wymagany, jeśli action zawiera bit „suppress event”

Zwracane wartości

(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych zdarzeń we właściwości eventids.

Przykłady

Potwierdzanie zdarzenia

Potwierdź pojedyncze zdarzenie i pozostaw wiadomość.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Problem rozwiązany."
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427"
        ]
    },
    "id": 1
}

Zmiana ważności zdarzenia

Zmień ważność wielu zdarzeń i pozostaw wiadomość.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Maintenance required to fix it.",
        "severity": 4
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427",
            "20428"
        ]
    },
    "id": 1
}

Źródło

CEvent::acknowledge() w ui/include/classes/api/services/CEvent.php.