Documentation
Sidebar
Table of Contents
event.get
Описание
целое число/массив event.get(объект параметры)
Этот метод позволяет получать события в соответствии с заданными параметрами.
Параметр
(объект) Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| eventids | строка/массив | Возврат событий только с заданными ID. |
| groupids | строка/массив | Возврат только тех событий, которые созданы объектами принадлежащими заданным группам узлов сети. |
| hostids | строка/массив | Возврат только тех событий, которые созданы объектами принадлежащими заданным узлам сети. |
| objectids | строка/массив | Возврат только тех событий, которые созданы заданными объектами. |
| object | целое число | Возврат только тех событий, которые созданы объектами заданного типа. Обратитесь к странице объекта события для получения списка поддерживаемых типов объекта. По умолчанию: 0 - триггер. |
| acknowledged | логический | Если задано равным true, получение только подтвержденных событий. |
| eventid_from | строка | Возврат только тех событий, ID которых больше или равен заданному ID. |
| eventid_till | строка | Возврат только тех событий, ID которых меньше или равен заданному ID. |
| source | целое число | Возврат событий только с заданным типом. Обратитесь к странице объекта события для получения списка поддерживаемых типов событий. По умолчанию: 0 - события на триггеры. |
| time_from | штамп времени | Возврат только тех событий, которые были созданы после или в заданное время. |
| time_till | штамп времени | Возврат только тех событий, которые были созданы до или в заданное время. |
| value | целое число/массив | Возврат только тех событий, которые имеют заданные значения. |
| selectHosts | запрос | Возврат узлов сети содержащих объект, который создал событие, в свойстве hosts. Поддерживается только для событий, которые сформированы триггерами, элементами данных или правилами LLD. |
| selectRelatedObject | запрос | Возврат объекта, который создал событие, в свойстве relatedObject. Тип возвращаемого объекта зависит от типа события. |
| select_alerts | запрос | Возврат оповещений, которые сгенерированы событием, в свойстве alerts. Оповещения отсортированы в обратном хронологическом порядке. |
| select_acknowledges | запрос | Возврат подтверждений события в свойстве acknowledges. Подтверждения отсортированы в обратном хронологическом порядке.Объект подтверждения события имеет следующие свойства: acknowledgeid - (строка) ID подтверждения;userid - (строка) ID пользователя, который подтвердил событие;eventid - (строка) ID подтвержденного события;clock - (штамп времени) время, когда событие было подтверждено;message - (строка) текст сообщения подтверждения;alias - (строка) псевдоним пользователя, который подтвердил событие;name - (строка) имя пользователя, который подтвердил событие;surname - (строка) фамилия пользователя, который подтвердил событие.Поддерживается count. |
| 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",
"objectids": "13926",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Ответ:
{
"jsonrpc": "2.0",
"result": [
{
"acknowledges": [
{
"acknowledgeid": "1",
"userid": "1",
"eventid": "9695",
"clock": "1350640590",
"message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
"alias": "Admin"
}
],
"eventid": "9695",
"source": "0",
"object": "0",
"objectid": "13926",
"clock": "1347970410",
"value": "1",
"acknowledged": "1",
"ns": "413316245"
},
{
"acknowledges": [],
"eventid": "9671",
"source": "0",
"object": "0",
"objectid": "13926",
"clock": "1347970347",
"value": "0",
"acknowledged": "0",
"ns": "0"
}
],
"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"
},
{
"eventid": "20617",
"source": "0",
"object": "0",
"objectid": "14283",
"clock": "1350477814",
"value": "0",
"acknowledged": "0",
"ns": "0"
},
{
"eventid": "20618",
"source": "0",
"object": "0",
"objectid": "14284",
"clock": "1350477815",
"value": "1",
"acknowledged": "0",
"ns": "0"
}
],
"id": 1
}Смотрите также
Исходный код
CEvent::get() в frontends/php/include/classes/api/services/CEvent.php.