alert.get

Описание

integer/array alert.get(параметры объекта)

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

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

Параметры

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

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

Параметр	Тип	Описание
alertids	string/array	Возвращает только оповещения с заданными IDs.
actionids	string/array	Возвращает только оповещения, созданные указанными действиями.
eventids	string/array	Возвращает только оповещения, созданные указанными событиями.
groupids	string/array	Возвращает только оповещения, созданные объектами из заданных групп узлов сети.
hostids	string/array	Возвращает только оповещения, созданные объектами с заданных узлов сети.
mediatypeids	string/array	Возвращать только сообщения оповещений в которых использовались заданные способы оповещений.
objectids	string/array	Возвращает только оповещения созданные указанными объектами
userids	string/array	Возвращает только сообщения оповещений которые были отправлены указанным пользователям.
eventobject	integer	Возвращает только оповещения созданные событиями связанными с объектами данного типа. См. список событий "object" поддерживаемые типы объектов. По умолчанию: 0 - триггер.
eventsource	integer	Возвращает только оповещения, созданные событиями заданного типа. См. список поддерживаемых типов событий в событии "source" . По умолчанию: 0 – события оповещений.
time_from	timestamp	Возвращает только оповещения, созданные после указанного времени.
time_till	timestamp	Возвращает только оповещения, созданные до указанного времени.
selectHosts	query	Возвращает свойство hosts с данными узлов сети которые инициировали операцию действия.
selectMediatypes	query	Возвращает свойство mediatypes с массивом способов оповещений, которые использовались для сообщения оповещения.
selectUsers	query	Возвращает свойство users с массивом пользователей которым было адресовано сообщение.
sortfield	string/array	Сортировать результат по заданным свойствам. Возможные значения: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto` и `status`.
countOutput	boolean	Эти параметры являются общими для всех методов `get` и описаны в справочных комментариях.
редактируемый	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".

Request:

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

Response:

{
        · "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() in ui/include/classes/api/services/CAlert.php.

Documentation