action.get

Опис

integer/array action.get(object parameters)

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

Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. [Ролі користувача] /manual/web_interface/frontend_sections/administration/user_roles) для отримання додаткової інформації.

Параметри

(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 і 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.

Приклади

Отримати тригерні дії

Отримати всі налаштовані тригерні дії разом із умовами дії та операціями.

Запит:

{
           "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
       }

Отримати дії виявлення

Отримати всі налаштовані дії виявлення разом із умовами дій та операціями. Фільтр використовує тип оцінки "and", тому властивість 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() у ui/include/classes/api/services/CAction.php.