Documentation
Table of Contents
alert.get
Описание
целое число/массив alert.get(объект параметры)
Этот метод позволяет получать информацию по оповещениям в соответствии с заданными параметрами.
Параметры
(объект) Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| alertids | строка/массив | Возврат оповещений только с заданными ID. |
| actionids | строка/массив | Возврат только тех оповещений, которые были сформированы заданными действиями. |
| eventids | строка/массив | Возврат только тех оповещений, которые были сформированы заданными событиями. |
| groupids | строка/массив | Возврат только тех оповещений, которые были сформированы объектами из заданных групп узлов сети. |
| hostids | строка/массив | Возврат только тех оповещений, которые были сформированы объектами из заданных узлов сети. |
| mediatypeids | строка/массив | Возврат только тех оповещений, которые использовали заданные способы оповещений. |
| objectids | строка/массив | Возврат только тех оповещений, которые были сформированы заданными объектами |
| userids | строка/массив | Возврат только тех оповещений, которые были отправлены заданным пользователям. |
| eventobject | целое число | Возврат только тех оповещений, которые были сформированы событиями связанными с объектами заданного типа. Обратитесь к свойству события "object" для получения списка поддерживаемых типов объекта. По умолчанию: 0 - триггер. |
| eventsource | целое число | Возврат только тех оповещений, которые были сформированы событиями заданного типа. Обратитесь к свойству события "source" для получения списка поддерживаемых типов события. По умолчанию: 0 - события на триггеры. |
| time_from | штамп времени | Возврат только тех оповещений, которые были сформированы после заданного времени. |
| time_till | штамп времени | Возврат только тех оповещений, которые были сформированы до заданного времени. |
| selectHosts | запрос | Возврат узлов сети, которые вызвали операцию действия, в свойстве hosts. |
| selectMediatypes | запрос | Возврат способа оповещения, которое использовалось для оповещения, в виде массива в свойстве mediatypes. |
| selectUsers | запрос | Возврат пользователя, которому было адресовано сообщение, в виде массива в свойстве users. |
| sortfield | строка/массив | Сортировка результата в соответствии с заданными свойствами. Возможные значения: alertid, clock, eventid и status. |
| countOutput | флаг | Эти параметры являются общими для всех методов get и они описаны в справочных комментариях. |
| editable | логический | |
| excludeSearch | флаг | |
| filter | объект | |
| limit | целое число | |
| output | запрос | |
| preservekeys | флаг | |
| search | объект | |
| searchByAny | логический | |
| searchWildcardsEnabled | логический | |
| sortorder | строка/массив | |
| startSearch | флаг |
Возвращаемые значения
(целое число/массив) Возвращает либо:
- массив объектов;
- количество найденных объектов, если используется параметр
countOutput.
Примеры
Получение оповещений по ID
Получение всех оповещений, которые были сформированы действием "3".
Запрос:
{ "jsonrpc": "2.0", "method": "alert.get", "params": { "output": "extend", "actionids": "3" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "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" } ], "id": 1 }Смотрите также
Исходный код
CAlert::get() в frontends/php/include/classes/api/services/CAlert.php.