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ń powagę zdarzenia. Jeśli zdarzenie ma już taką samą powagę, ta akcja zostanie pominięta.
  • Wycisz zdarzenie. Jeśli zdarzenie jest już wyciszone, ta akcja zostanie pominięta.
  • Cofnij wyciszenie zdarzenia. Jeśli zdarzenie nie jest wyciszone, ta akcja zostanie pominięta.
  • Zmień rangę zdarzenia na przyczynę. Jeśli zdarzenie ma już rangę przyczyny, ta akcja zostanie pominięta.
  • Zmień rangę zdarzenia na objaw. Jeśli zdarzenie ma już rangę objawu, 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 powagi 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ń oraz operacji aktualizacji, które mają zostać wykonane.

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

Zachowanie parametru:
- required
action integer Akcja(-e) aktualizacji zdarzenia.

Dostępne wartości bitmapy:
1 - zamknij problem;
2 - potwierdź zdarzenie;
4 - dodaj wiadomość;
8 - zmień ważność;
16 - cofnij potwierdzenie zdarzenia;
32 - wstrzymaj zdarzenie;
64 - wznow wstrzymanie zdarzenia;
128 - zmień rangę zdarzenia na przyczynę;
256 - zmień rangę zdarzenia na objaw.

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

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

Zachowanie parametru:
- required jeśli action zawiera bit "change event rank to symptom"
message string Treść wiadomości.

Zachowanie parametru:
- required jeśli action zawiera bit "add message"
severity integer Nowa ważność zdarzeń.

Dostępne wartości:
0 - nie sklasyfikowano;
1 - informacja;
2 - ostrzeżenie;
3 - przeciętna;
4 - wysoka;
5 - katastrofa.

Zachowanie parametru:
- required jeśli action zawiera bit "change severity"
suppress_until integer Znacznik czasu Unix, do którego zdarzenie musi być wstrzymane.

Jeśli ustawiono na "0", wstrzymanie będzie bezterminowe.

Zachowanie parametru:
- required jeśli action zawiera bit "suppress event"

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
}

Cofnięcie wyciszenia zdarzenia

Cofnij wyciszenie pojedynczego wcześniej wyciszonego zdarzenia.

Żą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.