alert.get

Описание

integer/array alert.get(объект parameters)

Метод позволяет получать оповещения по заданным параметрам.

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

Параметры

(object) Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

Parameter Type Description
alertids ID/array Возвращать только оповещения с указанными ID.
actionids ID/array Возвращать только оповещения, сгенерированные указанными действиями.
eventids ID/array Возвращать только оповещения, сгенерированные указанными событиями.
groupids ID/array Возвращать только оповещения, сгенерированные объектами из указанных групп узлов сети.
hostids ID/array Возвращать только оповещения, сгенерированные объектами из указанных узлов сети.
mediatypeids ID/array Возвращать только оповещения сообщений, использовавшие указанные типы медиа.
objectids ID/array Возвращать только оповещения, сгенерированные указанными объектами
userids ID/array Возвращать только оповещения сообщений, отправленные указанным пользователям.
eventobject integer Возвращать только оповещения, сгенерированные событиями, связанными с объектами указанного типа.

См. event object для списка поддерживаемых типов объектов.

По умолчанию: 0 - триггер.
eventsource integer Возвращать только оповещения, сгенерированные событиями указанного типа.

См. event source для списка поддерживаемых типов событий.

По умолчанию: 0 - события триггера.
time_from timestamp Возвращать только оповещения, сгенерированные после указанного времени.
time_till timestamp Возвращать только оповещения, сгенерированные до указанного времени.
selectHosts query Возвращать свойство hosts с данными узлов сети, которые вызвали операцию действия.
selectMediatypes query Возвращать свойство mediatypes с массивом типов медиа, использованных для оповещения сообщения.

См. mediatype.get для ограничений, зависящих от типа пользователя.
selectUsers query Возвращать свойство users с массивом пользователей, которым было адресовано сообщение.

См. user.get для ограничений, зависящих от типа пользователя.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: alertid, clock, eventid, mediatypeid, sendto, status.
countOutput boolean Эти параметры описаны в reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

(integer/array) Возвращает:

  • · массив объектов;
  • · количество извлеченных объектов, если использовался параметр countOutput.

Примеры

Получение предупреждений по ID действия

Получить все оповещения, созданные действием "3".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "[email protected]",
            "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
            "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}

См. также

Источник

CAlert::get() в ui/include/classes/api/services/CAlert.php.