Это перевод страницы документации с английского языка. Помогите нам сделать его лучше.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

action.get

Описание

целое число/массив action.get(объект параметры)

Этот метод позволяет получать действия согласно заданным параметрам.

Этот метод доступен всем типам пользователей. Разрешение на использование данного метода можно отозвать в настройках роли пользователя. Подробнее смотрите Роли пользователей

Параметры

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

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

Параметр Тип Описание
actionids string/array Возвращает только действия с заданными идентификаторами.
groupids string/arrayв Возвращает только те действия которые используют заданные группы хостов в условиях действия.
hostids string/array Возвращает только те действия которые используют указанные хосты в условиях действия.
triggerids string/array Возвращает только те действия, которые используют данные триггеры в условиях действия.
mediatypeids string/array Возвращает только те действия которые используют данные типы медиа для отправки сообщений.
usrgrpids string/array Возвращает только те действия которые настроены на отправку сообщений указанным группам пользователей.
userids string/array Возвращает только те действия которые настроены на отправку сообщений указанным пользователям.
scriptids string/array Возвращает только те действия которые настроены для запуска заданных скриптов.
selectFilter query Возвращает свойство filter с фильтром условия действия.
selectOperations query Возвращает свойство operations с операциями действия.
selectRecoveryOperations query Возвращает свойство recovery_operations с операциями восстановления действий.
selectUpdateOperations query Возвращает свойство update_operations с операциями обновления действий.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: actionid, name and 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

Возвращаемые значения

(целое число/массив) Возвращает:

  • массив объектов или
  • количество полученных объектов , если был использован параметр countOutput.

Примеры

Получение действий триггеров

Вовращает все настроенные действия триггеров с условиями и операциями действия.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "action.get",
           "params": {
               "output": "extend",
               "selectOperations": "extend",
               "selectRecoveryOperations": "extend",
               "selectUpdateOperations": "extend",
               "selectFilter": "extend",
               "filter": {
                   "eventsource": 0
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "actionid": "3",
                   "name": "Report problems to Zabbix administrators",
                   "eventsource": "0",
                   "status": "1",
                   "esc_period": "1h",
                   "pause_suppressed": "1",
                   "filter": {
                       "evaltype": "0",
                       "formula": "",
                       "conditions": [],
                       "eval_formula": ""
                   },
                   "operations": [
                       {
                           "operationid": "3",
                           "actionid": "3",
                           "operationtype": "0",
                           "esc_period": "0",
                           "esc_step_from": "1",
                           "esc_step_to": "1",
                           "evaltype": "0",
                           "opconditions": [],
                           "opmessage": [
                               {
                                   "default_msg": "1",
                                   "subject": "",
                                   "message": "",
                                   "mediatypeid" => "0"
                               }
                           ],
                           "opmessage_grp": [
                               {
                                   "usrgrpid": "7"
                               }
                           ]
                       }
                   ],
                   "recovery_operations": [
                       {
                           "operationid": "7",
                           "actionid": "3",
                           "operationtype": "11",
                           "evaltype": "0",
                           "opconditions": [],
                           "opmessage": {
                               "default_msg": "0",
                               "subject": "{TRIGGER.STATUS}: {TRIGGER.NAME}",
                               "message": "Trigger: {TRIGGER.NAME}\r\nTrigger status: {TRIGGER.STATUS}\r\nTrigger severity: {TRIGGER.SEVERITY}\r\nTrigger URL: {TRIGGER.URL}\r\n\r\nItem values:\r\n\r\n1. {ITEM.NAME1} ({HOST.NAME1}:{ITEM.KEY1}): {ITEM.VALUE1}\r\n2. {ITEM.NAME2} ({HOST.NAME2}:{ITEM.KEY2}): {ITEM.VALUE2}\r\n3. {ITEM.NAME3} ({HOST.NAME3}:{ITEM.KEY3}): {ITEM.VALUE3}\r\n\r\nOriginal event ID: {EVENT.ID}",
                               "mediatypeid": "0"
                           }
                       }
                   ],
                   "update_operations": [
                       {
                           "operationid": "31",
                           "operationtype": "12",
                           "evaltype": "0",
                           "opmessage": {
                               "default_msg": "1",
                               "subject": "",
                               "message": "",
                               "mediatypeid": "0"
                           }
                       },
                       {
                           "operationid": "32",
                           "operationtype": "0",
                           "evaltype": "0",
                           "opmessage": {
                               "default_msg": "0",
                               "subject": "Updated: {TRIGGER.NAME}",
                               "message": "{USER.FULLNAME} updated problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} with the following message:\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nCurrent problem status is {EVENT.STATUS}",
                               "mediatypeid": "1"
                           },
                           "opmessage_grp": [
                               {
                                   "usrgrpid": "7"
                               }
                           ],
                           "opmessage_usr": []
                       },
                       {
                           "operationid": "33",
                           "operationtype": "1",
                           "evaltype": "0",
                           "opcommand": {
                               "scriptid": "3"
                           },
                           "opcommand_hst": [
                               {
                                   "hostid": "10084"
                               }
                           ],
                           "opcommand_grp": []
                       }
                   ]
               }
           ],
           "id": 1
       }

Получение действий обнаружения

Возвращает все настроенные действия обнаружения вместе с условиями и операциями действия. Фильтр использует тип вычисления "и", поэтому свойство formula будет пустое а свойствоeval_formula генерируется автоматически.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "action.get",
           "params": {
               "output": "extend",
               "selectOperations": "extend"
               "selectFilter": "extend",
               "filter": {
                   "eventsource": 1
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "actionid": "2",
                   "name": "Auto discovery. Linux servers.",
                   "eventsource": "1",
                   "status": "1",
                   "esc_period": "0s",
                   "pause_suppressed": "1",
                   "filter": {
                       "evaltype": "0",
                       "formula": "",
                       "conditions": [
                           {
                               "conditiontype": "10",
                               "operator": "0",
                               "value": "0",
                               "value2": "",
                               "formulaid": "B"
                           },
                           {
                               "conditiontype": "8",
                               "operator": "0",
                               "value": "9",
                               "value2": "",
                               "formulaid": "C"
                           },
                           {
                               "conditiontype": "12",
                               "operator": "2",
                               "value": "Linux",
                               "value2": "",
                               "formulaid": "A"
                           }
                       ],
                       "eval_formula": "A and B and C"
                   },
                   "operations": [
                       {
                           "operationid": "1",
                           "actionid": "2",
                           "operationtype": "6",
                           "esc_period": "0s",
                           "esc_step_from": "1",
                           "esc_step_to": "1",
                           "evaltype": "0",
                           "opconditions": [],
                           "optemplate": [
                               {
                                   "templateid": "10001"
                               }
                           ]
                       },
                       {
                           "operationid": "2",
                           "actionid": "2",
                           "operationtype": "4",
                           "esc_period": "0s",
                           "esc_step_from": "1",
                           "esc_step_to": "1",
                           "evaltype": "0",
                           "opconditions": [],
                           "opgroup": [
                               {
                                   "groupid": "2"
                               }
                           ]
                       }
                   ]
               }
           ],
           "id": 1
       }

Смотрите также

Исходный код

CAction::get() in ui/include/classes/api/services/CAction.php.