event.acknowledge

Opis

object event.acknowledge(object/array parameters)

Ta metoda umożliwia aktualizację zdarzeń. Można wykonać następujące akcje aktualizacji:

  • Zamknij zdarzenie. Jeśli zdarzenie jest już rozwiązane, ta akcja zostanie pominięta.
  • Potwierdź zdarzenie. Jeśli zdarzenie jest już potwierdzone, ta akcja zostanie pominięta.
  • Cofnij potwierdzenie zdarzenia. Jeśli zdarzenie nie jest potwierdzone, ta akcja zostanie pominięta.
  • Dodaj wiadomość.
  • Zmień poziom ważności zdarzenia. Jeśli zdarzenie ma już ten sam poziom ważności, ta akcja zostanie pominięta.
  • Wycisz zdarzenie. Jeśli zdarzenie jest już wyciszone, ta akcja zostanie pominięta.
  • Przywróć wyciszenie zdarzenia. Jeśli zdarzenie nie jest wyciszone, ta akcja zostanie pominięta.
  • Zmień rangę zdarzenia na przyczynę. Jeśli zdarzenie jest już oznaczone jako przyczyna, ta akcja zostanie pominięta.
  • Zmień rangę zdarzenia na objaw. Jeśli zdarzenie jest już oznaczone jako objaw, ta akcja zostanie pominięta.

Można aktualizować tylko zdarzenia wyzwalaczy.
Można aktualizować tylko zdarzenia problemów.
Do zamknięcia zdarzenia lub zmiany jego poziomu ważności wymagane są uprawnienia odczytu/zapisu dla wyzwalacza.
Aby zamknąć zdarzenie, w wyzwalaczu musi być dozwolone ręczne zamknięcie.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można odebrać 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ń i operacje aktualizacji, które powinny zostać wykonane.

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

Zachowanie parametru:
- wymagane
action integer Operacja(-e) aktualizacji zdarzenia.

Możliwe wartości bitowe:
1 - zamknięcie problemu;
2 - potwierdzenie zdarzenia;
4 - dodanie wiadomości;
8 - zmiana ważności;
16 - anulowanie potwierdzenia zdarzenia;
32 - wyciszenie zdarzenia;
64 - anulowanie wyciszenia zdarzenia;
128 - zmiana rangi zdarzenia na przyczynę;
256 - zmiana rangi zdarzenia na objaw.

To pole jest maską bitową; dopuszczalna jest dowolna suma możliwych wartości bitowych (na przykład 6 w celu potwierdzenia zdarzenia i pozostawienia wiadomości albo 34 w celu potwierdzenia i wyciszenia zdarzenia).

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

Zachowanie parametru:
- wymagane, jeśli action zawiera bit „zmiana rangi zdarzenia na objaw”
message string Treść wiadomości.

Zachowanie parametru:
- wymagane, jeśli action zawiera bit „dodanie wiadomości”
severity integer Nowa ważność zdarzeń.

Możliwe wartości:
0 - niesklasyfikowane;
1 - informacje;
2 - ostrzeżenie;
3 - średnia;
4 - wysoka;
5 - katastrofa.

Zachowanie parametru:
- wymagane, jeśli action zawiera bit „zmiana ważności”
suppress_until integer Znacznik czasu Unix, do którego zdarzenie musi być wyciszone.

Jeśli ustawiono wartość „0”, wyciszenie będzie obowiązywać bezterminowo.

Zachowanie parametru:
- wymagane, jeśli action zawiera bit „wyciszenie zdarzenia”

Zwracane wartości

(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych zdarzeń w 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
}

Wyciszanie zdarzenia bezterminowo

Wycisz pojedyncze zdarzenie bez czasu wygaśnięcia.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 32,
        "suppress_until": 0
    },
    "id": 1
}

Odpowiedź:

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

Przywracanie zdarzenia

Przywróć pojedyncze wcześniej wyciszone zdarzenie.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 64
    },
    "id": 1
}

Odpowiedź:

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

Potwierdź i wycisz zdarzenie

Potwierdź jedno lub więcej zdarzeń, dodaj wiadomość i wycisz je w tym samym żądaniu.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": [
            "20427",
            "20428"
        ],
        "action": 38,
        "message": "Suppressing during planned maintenance.",
        "suppress_until": 0
    },
    "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.