event.acknowledge

Описание

object event.acknowledge(object/array parameters)

Этот метод позволяет обновлять события. Можно выполнить следующие действия обновления:

  • Закрыть событие. Если событие уже решено, это действие будет пропущено.
  • Подтвердить событие. Если событие уже подтверждено, это действие будет пропущено.
  • Снять подтверждение с события. Если событие не подтверждено, это действие будет пропущено.
  • Добавить сообщение.
  • Изменить серьезность события. Если у события уже такая же серьезность, это действие будет пропущено.
  • Подавить событие. Если событие уже подавлено, это действие будет пропущено.
  • Снять подавление с события. Если событие не подавлено, это действие будет пропущено.
  • Изменить ранг события на cause. Если событие уже имеет ранг cause, это действие будет пропущено.
  • Изменить ранг события на symptom. Если событие уже имеет ранг symptom, это действие будет пропущено.

Обновлять можно только события триггера.
Обновлять можно только problem-события.
Для закрытия события или изменения его серьезности требуются права чтения/записи для триггера.
Чтобы закрыть событие, в триггере должно быть разрешено ручное закрытие.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках роли пользователя. См. Роли пользователей для получения дополнительной информации.

Параметры

(object/array) Параметры, содержащие IDs событий и операций обновления, которые должны быть выполнены.

Parameter Type Description
eventids ID/array IDs событий, которые нужно подтвердить.

Поведение параметра:
- required
action integer Действие(я) обновления события.

Возможные значения битовой карты:
1 - закрыть проблему;
2 - подтвердить событие;
4 - добавить сообщение;
8 - изменить серьезность;
16 - снять подтверждение события;
32 - подавить событие;
64 - отменить подавление события;
128 - изменить ранг события на cause;
256 - изменить ранг события на symptom.

Это поле является битовой маской; допустима любая сумма возможных значений битовой карты (например, 34 для подтверждения и подавления события).

Поведение параметра:
- required
cause_eventid ID ID события cause.

Поведение параметра:
- required если action содержит бит "change event rank to symptom"
message string Текст сообщения.

Поведение параметра:
- required если action содержит бит "add message"
severity integer Новая серьезность для событий.

Возможные значения:
0 - not classified;
1 - information;
2 - warning;
3 - average;
4 - high;
5 - disaster.

Поведение параметра:
- required если action содержит бит "change severity"
suppress_until integer Unix timestamp, до которого событие должно быть подавлено.

Если установлено значение "0", подавление будет бессрочным.

Поведение параметра:
- required если action содержит бит "suppress event"

Возвращаемые значения

(object) Возвращает объект, содержащий идентификаторы обновленных событий в свойстве eventids.

Примеры

Подтверждение события

Подтвердите одно событие и оставьте сообщение.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Проблема устранена."
    },
    "id": 1
}

Ответ:

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

Изменение важности события

Измените важность для нескольких событий и оставьте сообщение.

Запрос:

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

Ответ:

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

Suppressing an event indefinitely

Suppress a single event without an expiration time.

Request:

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

Response:

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

Unsuppressing an event

Unsuppress a single previously suppressed event.

Request:

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

Response:

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

Acknowledge and suppress an event

Acknowledge one or more events, add a message, and suppress them in the same request.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": [
            "20427",
            "20428"
        ],
        "action": 38,
        "message": "Suppressing during planned maintenance.",
        "suppress_until": 0
    },
    "id": 1
}

Response:

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

Источник

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