Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

action.get

Описание

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

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

Параметры

(объект) Параметры задают желаемый вывод.

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

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

Возможные значения: actionid, name и status.
countOutput логический Эти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
filter объект
limit целое число
output запрос
preservekeys логический
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch логический

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

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

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

Примеры

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

Получение всех добавленных действий на обнаружение вместе с условиями и операциями действия. Фильтр использует "и" тип вычисления, таким образом свойство 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",
           "method": "action.get",
           "params": {
               "output": "extend",
               "selectOperations": "extend",
               "selectRecoveryOperations": "extend",
               "selectFilter": "extend",
               "filter": {
                   "eventsource": 1
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "actionid": "2",
                   "name": "Auto discovery. Linux servers.",
                   "eventsource": "1",
                   "status": "1",
                   "esc_period": "0s",
                   "def_shortdata": "",
                   "def_longdata": "",
                   "r_shortdata": "",
                   "r_longdata": "",
                   "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": [
                               {
                                   "operationid": "1",
                                   "templateid": "10001"
                               }
                           ]
                       },
                       {
                           "operationid": "2",
                           "actionid": "2",
                           "operationtype": "4",
                           "esc_period": "0s",
                           "esc_step_from": "1",
                           "esc_step_to": "1",
                           "evaltype": "0",
                           "opconditions": [],
                           "opgroup": [
                               {
                                   "operationid": "2",
                                   "groupid": "2"
                               }
                           ]
                       }
                   ],
                   "recoveryOperations": [
                       {
                           "operationid": "585",
                           "actionid": "2",
                           "operationtype": "11",
                           "evaltype": "0",
                           "opconditions": [],
                           "opmessage": {
                               "operationid": "585",
                               "default_msg": "1",
                               "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"
                           }
                       }
                   ],
                   "acknowledgeOperations": [
                       {
                           "operationid": "585",
                           "operationtype": "12",
                           "evaltype": "0",
                           "opmessage": {
                               "default_msg": "1",
                               "subject": "Acknowledged: {TRIGGER.NAME}",
                               "message": "{USER.FULLNAME} acknowledged problem at {ACK.DATE} {ACK.TIME} with the following message:\r\n{ACK.MESSAGE}\r\n\r\nCurrent problem status is {EVENT.STATUS}",
                               "mediatypeid": "0"
                           }
                       },
                       {
                           "operationid": "586",
                           "operationtype": "0",
                           "evaltype": "0",
                           "opmessage": {
                               "default_msg": "1",
                               "subject": "Acknowledged: {TRIGGER.NAME}",
                               "message": "{USER.FULLNAME} acknowledged problem at {ACK.DATE} {ACK.TIME} with the following message:\r\n{ACK.MESSAGE}\r\n\r\nCurrent problem status is {EVENT.STATUS}",
                               "mediatypeid": "0"
                           },
                           "opmessage_grp": [
                               {
                                   "usrgrpid": "7"
                               }
                           ],
                           "opmessage_usr": []
                       },
                       {
                           "operationid": "587",
                           "operationtype": "1",
                           "evaltype": "0",
                           "opcommand": {
                               "type": "0",
                               "scriptid": "0",
                               "execute_on": "0",
                               "port": "",
                               "authtype": "0",
                               "username": "",
                               "password": "",
                               "publickey": "",
                               "privatekey": "",
                               "command": "notify.sh"
                           },
                           "opcommand_hst": [
                               {
                                   "hostid": "0"
                               }
                           ],
                           "opcommand_grp": []
                       }
                   ]
               }
           ],
           "id": 1
       }

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

Исходный код

CAction::get() в frontends/php/include/classes/api/services/CAction.php.