This is a translation of the original English documentation page. Help us make it better.

alert.get

Опис

integer/array alert.get(object parameters)

Метод дозволяє отримувати оповіщення за заданими параметрами.

Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. Ролі користувача для отримання додаткової інформації.

Параметри

(object) Параметри, що визначають бажаний результат.

Метод підтримує такі параметри.

Параметр Тип Опис
alertids string/array Повертати лише сповіщення з указаними ідентифікаторами.
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 Повертати лише сповіщення, створені подіями вказаного типу.

Перегляньте подію "джерело", щоб переглянути список підтримуваних типів подій .

За замовчуванням: 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, описані в довідковому коментарі.
editable 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.

Приклади

Отримувати сповіщення за ідентифікатором дії

Отримати всі сповіщення, згенеровані дією «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",
                   "p_eventid": "0",
                   "acknowledgeid": "0"
               }
           ],
           "id": 1
       }

Дивись також

Джерело

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