event.acknowledge

Описание

object event.acknowledge(object/array parameters)

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

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

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

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

Параметры

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

Parameter Type Description
eventids ID/array Идентификаторы событий, которые необходимо подтвердить.

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

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

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

Поведение параметра:
- обязательный
cause_eventid ID Идентификатор события-причины.

Поведение параметра:
- обязательный, если action содержит бит «изменить ранг события на симптом»
message string Текст сообщения.

Поведение параметра:
- обязательный, если action содержит бит «добавить сообщение»
severity integer Новая важность событий.

Возможные значения:
0 - не классифицировано;
1 - информация;
2 - предупреждение;
3 - средняя;
4 - высокая;
5 - катастрофа.

Поведение параметра:
- обязательный, если action содержит бит «изменить важность»
suppress_until integer Метка времени Unix, до которой событие должно быть подавлено.

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

Поведение параметра:
- обязательный, если action содержит бит «подавить событие»

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

(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
}

Подавление события на неопределенный срок

Подавить одно событие без времени истечения.

Запрос:

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

Ответ:

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

Снятие подавления события

Снимите подавление с одного ранее подавленного события.

Запрос:

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

Ответ:

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

Подтвердить и подавить событие

Подтвердите одно или несколько событий, добавьте сообщение и подавите их в одном запросе.

Запрос:

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

Ответ:

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

Источник

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