[comment]: # ({4c82c7ad-4c82c7ad})
# alert.get

[comment]: # ({/4c82c7ad-4c82c7ad})

[comment]: # ({3c5ac067-ed55724c})
### Описание

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

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

::: noteclassic
Этот метод доступен для пользователей любого типа. Права доступа
вызова метода можно отменить в настройках роли пользователя. Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/3c5ac067-ed55724c})

[comment]: # ({7c3d247f-218fa8cf})
### Параметры

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

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|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|Возвращать только оповещения, сгенерированные событиями, связанными с объектами указанного типа.<br><br>См. event [`object`](/manual/api/reference/event/object#event) для списка поддерживаемых типов объектов.<br><br>По умолчанию: 0 - триггер.|
|eventsource|integer|Возвращать только оповещения, сгенерированные событиями указанного типа.<br><br>См. event [`source`](/manual/api/reference/event/object#event) для списка поддерживаемых типов событий.<br><br>По умолчанию: 0 - события триггера.|
|time\_from|timestamp|Возвращать только оповещения, сгенерированные после указанного времени.|
|time\_till|timestamp|Возвращать только оповещения, сгенерированные до указанного времени.|
|selectHosts|query|Возвращать свойство [`hosts`](/manual/api/reference/host/object) с данными узлов сети, которые вызвали операцию действия.|
|selectMediatypes|query|Возвращать свойство [`mediatypes`](/manual/api/reference/mediatype/object) с массивом типов медиа, использованных для оповещения сообщения.<br><br>См. [`mediatype.get`](/manual/api/reference/mediatype/get) для ограничений, зависящих от типа пользователя.|
|selectUsers|query|Возвращать свойство [`users`](/manual/api/reference/user/object) с массивом пользователей, которым было адресовано сообщение.<br><br>См. [`user.get`](/manual/api/reference/user/get) для ограничений, зависящих от типа пользователя.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto`, `status`.|
|countOutput|boolean|Эти параметры описаны в [reference commentary](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/7c3d247f-218fa8cf})

[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения

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

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Примеры

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({57a43812-8d56d57c})
#### Получение предупреждений по ID действия

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

[Запрос](/manual/api#performing-requests):

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

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "support@company.com",
            "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
}
```

[comment]: # ({/57a43812-8d56d57c})

[comment]: # ({c240ff85-5371aed2})
### См. также

-   [Узел сети](/manual/api/reference/host/object#host)
-   [Тип медиа](/manual/api/reference/mediatype/object#media-type)
-   [Пользователь](/manual/api/reference/user/object#user)

[comment]: # ({/c240ff85-5371aed2})

[comment]: # ({14a85885-14a85885})
### Источник

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

[comment]: # ({/14a85885-14a85885})