Sidebar

ru:manual:api:reference:event:get

event.get

Описание

целое число/массив event.get(объект параметры)

Этот метод позволяет получать события в соответствии с заданными параметрами.

Этот метод может вернуть события по удаленным объектам, если эти события ещё не были удалены процессом очистки истории.

Параметры

(объект) Параметры задают желаемый вывод.

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

Параметр Тип Описание
eventids строка/массив Возврат событий только с заданными ID.
groupids строка/массив Возврат только тех событий, которые созданы объектами принадлежащими заданным группам узлов сети.
hostids строка/массив Возврат только тех событий, которые созданы объектами принадлежащими заданным узлам сети.
objectids строка/массив Возврат только тех событий, которые созданы заданными объектами.
applicationids строка/массив Возврат только тех событий, которые созданы объектами принадлежащими заданным группам элементов данных. Примеряется только, если объектом являются триггер или элемент данных.
source целое число Возврат событий только с заданным типом.

Обратитесь к странице объекта события для получения списка поддерживаемых типов событий.

По умолчанию: 0 - события на триггеры.
object целое число Возврат только тех событий, которые созданы объектами заданного типа.

Обратитесь к странице объекта события для получения списка поддерживаемых типов объекта.

По умолчанию: 0 - триггер.
acknowledged логический Если задано равным true, получение только подтвержденных событий.
suppressed логический true - возврат только подавленных событий;
false - возврат событий в нормальном состоянии.
severities целое число/массив Возврат событий только с заданными важностями события. Применяется только, если объектом является триггер.
evaltype целое число Правила поиска тегов.

Возможные значения:
0 - (по умолчанию) И/Или;
2 - Или.
tags массив объектов Возврат событий только с заданными тегами. Точное соответствие тегу и не зависимый от регистра поиск по значению и оператору.
Формат: [{"tag": "<тег>", "value": "<значение>", "operator": "<оператор>"}, ...].
По всем событиям возвращается пустой массив.

Возможные типы операторов:
0 - (по умолчанию) Содержит;
1 - Равен.
eventid_from строка Возврат только тех событий, ID которых больше или равен заданному ID.
eventid_till строка Возврат только тех событий, ID которых меньше или равен заданному ID.
time_from штамп времени Возврат только тех событий, которые были созданы после или в заданное время.
time_till штамп времени Возврат только тех событий, которые были созданы до или в заданное время.
problem_time_from штамп времени Возврат только тех событий, которые были в состоянии проблемы начиная с problem_time_from. Применимо только, если источником является событие на триггер и объектом является триггер. Обязателен, если указан problem_time_till.
problem_time_till штамп времени Возврат только тех событий, которые были в состоянии проблемы до problem_time_till. Применимо только, если источником является событие на триггер и объектом является триггер. Обязателен, если указан problem_time_from.
value целое число/массив Возврат только тех событий, которые имеют заданные значения.
selectHosts запрос Возврат свойства hosts с узлами сети содержащих объект, который создал событие. Поддерживается только для событий, которые сформированы триггерами, элементами данных или правилами LLD.
selectRelatedObject запрос Возврат свойства relatedObject с объектом, который создал событие. Тип возвращаемого объекта зависит от типа события.
select_alerts запрос Возврат свойства alerts с оповещениями, которые были сгенерированы событием. Оповещения отсортированы в обратном хронологическом порядке.
select_acknowledges запрос Возврат свойства acknowledges с обновлениями события. Обновления событий отсортированы в обратном хронологическом порядке.

Объект обновления события имеет следующие свойства:
acknowledgeid - (строка) ID подтверждения;
userid - (строка) ID пользователя, который обновил событие;
eventid - (строка) ID обновленного события;
clock - (штамп времени) время, когда событие было обновлено;
message - (строка) текст сообщения;
action - (целое число) действие обновления, которое было выполнено, смотрите event.acknowledge;
old_severity - (целое число) важность события до этого действия обновления;
new_severity - (целое число) важность события после этого действия обновления;
alias - (строка) псевдоним пользователя, который обновил событие;
name - (строка) имя пользователя, который обновил событие;
surname - (строка) фамилия пользователя, который обновил событие.

Поддерживается count.
selectTags запрос Возврат свойства tags с тегами событий.
selectSuppressionData запрос Возврат свойства suppression_data со списком обслуживаний:
maintenanceid - (строка) ID обслуживания;
suppress_until - (целое число) время, до которого событие подавлено.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: eventid, objectid и clock.
countOutput логическийЭти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
filter объект
limit целое число
output запрос
preservekeys логический
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch логический

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

(целое число/массив) Возвращает либо:

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

Примеры

Получение событий на триггеры

Получение последних событий с триггера “13926.”

Запрос:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "select_acknowledges": "extend",
        "selectTags": "extend",
        "selectSuppressionData": "extend",
        "objectids": "13926",
        "sortfield": ["clock", "eventid"],
        "sortorder": "DESC"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "9695",
            "source": "0",
            "object": "0",
            "objectid": "13926",
            "clock": "1347970410",
            "value": "1",
            "acknowledged": "1",
            "ns": "413316245",
            "name": "MySQL is down",
            "severity": "5",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "acknowledges": [
                {
                    "acknowledgeid": "1",
                    "userid": "1",
                    "eventid": "9695",
                    "clock": "1350640590",
                    "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
                    "action": "6",
                    "old_severity": "0",
                    "new_severity": "0",
                    "alias": "Admin",
                    "name": "Zabbix",
                    "surname": "Administrator"
                }
            ],
            "suppression_data": [
                {
                    "maintenanceid": "15",
                    "suppress_until": "1472511600"
                }
            ],
            "suppressed": "1",
            "tags": [
                {
                    "tag": "service",
                    "value": "mysqld"
                },
                {
                    "tag": "error",
                    "value": ""
                }
            ]
        },
        {
            "eventid": "9671",
            "source": "0",
            "object": "0",
            "objectid": "13926",
            "clock": "1347970347",
            "value": "0",
            "acknowledged": "0",
            "ns": "0",
            "name": "Unavailable by ICMP ping",
            "severity": "4",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "acknowledges": [],
            "suppression_data": [],
            "suppressed": "0",
            "tags": []
        }
    ],
    "id": 1
}

Получение событий по периоду времени

Получение всех событий, которые созданы между 9 и 10 Октября, 2012, в обратном хронологическом порядке.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "time_from": "1349797228",
        "time_till": "1350661228",
        "sortfield": ["clock", "eventid"],
        "sortorder": "desc"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "20616",
            "source": "0",
            "object": "0",
            "objectid": "14282",
            "clock": "1350477814",
            "value": "1",
            "acknowledged": "0",
            "ns": "0",
            "name": "Less than 25% free in the history cache",
            "severity": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "suppressed": "0"
        },
        {
            "eventid": "20617",
            "source": "0",
            "object": "0",
            "objectid": "14283",
            "clock": "1350477814",
            "value": "0",
            "acknowledged": "0",
            "ns": "0",
            "name": "Zabbix trapper processes more than 75% busy",
            "severity": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "suppressed": "0"
        },
        {
            "eventid": "20618",
            "source": "0",
            "object": "0",
            "objectid": "14284",
            "clock": "1350477815",
            "value": "1",
            "acknowledged": "0",
            "ns": "0",
            "name": "High ICMP ping loss",
            "severity": "3",
            "r_eventid": "0",
            "c_eventid": "0",
            "correlationid": "0",
            "userid": "0",
            "opdata": "",
            "suppressed": "0"
        }
    ],
    "id": 1
}

Смотрите также

Исходный код

CEvent::get() в frontends/php/include/classes/api/services/CEvent.php.