> Объект действия

Следующие объекты напрямую связаны с API action.

Действие

Объект действия имеет следующие свойства.

Свойство	Тип	Описание
actionid	строка	(только чтение) ID действия.
esc_period (требуется)	строка	Длительность шага операции по умолчанию. Должна быть не менее 60 секунд. Принимает секунды, единицы времени с суффиксом и пользовательские макросы. Обратите внимание, что эскалации поддерживаются только для действий триггеров и сервисов, а так же внутренних действий и только в обычных операциях.
eventsource (требуется)	целое число	(константа) Тип событий, которые будет обрабатывать действие. Обратитесь к свойству событий "source" для получения списка поддерживаемых типов событий.
name (требуется)	строка	Имя действия.
status	целое число	Активировано действие или деактивировано. Возможные значения: 0 - (по умолчанию) активировано; 1 - деактивировано.
pause_suppressed	целое число	Приостанавливать эскалацию в течение периодов обслуживания или нет. Возможные значения: 0 - Не приостанавливать эскалацию; 1 - (по умолчанию) Приостановить эскалацию. Обратите внимание, что этот параметр действителен только для действий триггера.
notify_if_canceled	целое число	Оповещать ли о том, что эскалация отменена. Possible values: 0 - Не оповещать, что эскалация отменена; 1 - (по умолчанию) Оповещать об отмене эскалации. Обратите внимание, что этот параметр действителен только для действий триггера.

Операция действия

Объект операции действия определяет операцию, производимую при выполении действия. Этот объект имеет следующие свойства.

Свойство	Тип	Описание
operationid	строка	(только чтение) ID операции действия.
operationtype (требуется)	целое число	Тип операции. Возможные значения: 0 - отправка сообщения; 1 - глобальный скрипт; 2 - добавление узла сети; 3 - удаление узла сети; 4 - добавление в группу узлов сети; 5 - удаление из группы узлов сети; 6 - присоединение шаблона; 7 - отсоединение шаблона; 8 - активация узла сети; 9 - деактивация узла сети; 10 - установить режим инвентарных данных узла сети. Обратите внимание, что для действий триггеров и сервисов поддерживаются только типы «0» и «1», а для внутренних действий — только «0». Все типы поддерживаются для действий обнаружения и авторегистрации.
actionid	строка	(только чтение) ID действия, которому принадлежит операция.
esc_period	строка	Длительность шага эскалации в секундах. Должна быть больше 60 секунд. Принимает секунды, единицы времени с суффиксом и пользовательские макросы. Если задано равным 0 или 0s, будет использоваться период эскалации действия по умолчанию . По умолчанию: 0s. Обратите внимание, что эскалации поддерживаются только для действий триггеров и сервисов, внутренних действий и только в обычных операциях.
esc_step_from	целое число	Шаг начала эскалации. По умолчанию: 1. Обратите внимание, что эскалации поддерживаются только для действий триггеров и сервисов, внутренних действий и только в обычных операциях.
esc_step_to	целое число	Шаг завершения эскалации. По умолчанию: 1. Обратите внимание, что эскалации поддерживаются только для действий триггеров и сервисов, внутренних действий и только в обычных операциях.
evaltype	целое число	Метод вычисления условия операции. Возможные значения: 0 - (по умолчанию) И / ИЛИ; 1 - И; 2 - ИЛИ.
opcommand	объект	Объект, который содержит данные о глобальном скрипте в операции. Каждый объект имеет единственное свойство: `scriptid` - (строка) ID скрипта. Требуется для операций с глобальным скриптом.
opcommand_grp	массив	Группы узлов сети, на которых будут выполняться глобальные скрипты. Каждый объект имеет следующие свойства: `opcommand_grpid` - (строка, только чтение) ID объекта; `operationid` - (строка, только чтение) ID операции; `groupid` - (строка) ID группы узлов сети. Требуется при операциях с глобальным скриптом, если не задано `opcommand_hst`.
opcommand_hst	массив	Узел сети, на котором будет выполнен глобальный скрипт. Каждый объект имеет следующие свойства: `opcommand_hstid` - (строка, только чтение) ID объекта; `operationid` - (строка, только чтение) ID операции; `hostid` - (строка) ID узла сети; если задано значение «0», то команда будет выполняться на текущем узле сети. Требуется при операциях с глобальным скриптом, если не задано opcommand_grp.
opconditions	массив	Условия операции, которые используются для действий триггеров. Объект условия операции подробно описан ниже.
opgroup	массив	Группы узлов сети, в которые будут добавлены узлы сети. Каждый объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `groupid` - (строка) ID группы узлов сети Требуется для операций "добавление в группу узлов сети" и "удаление из группы узлов сети".
opmessage	объект	Объект, который содержит данные об отправляемом в операции сообщении. Объект сообщения операции подробно описан ниже.. Требуется для операций с сообщениями.
opmessage_grp	массив	Группы пользователей, которым будут отправляться сообщения. Каждый объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `usrgrpid` - (строка) ID группы пользователей. Требуется при операциях с сообщениями, если не задано `opmessage_usr`.
opmessage_usr	массив	Пользователи, которым будут отправляться сообщения. Каждый объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `userid` - (строка) ID пользователя. Требуется при операциях с сообщениями, если не задано `opmessage_grp`.
optemplate	массив	Шаблоны к которым будет присоединён узлы сети. Каждый объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `templateid` - (строка) ID шаблона. Требуется для операций "присоединение шаблона" и "отсоединение шаблона".
opinventory	объект	Режим инвентарных данных, который необходимо задать узлу сети. Объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `inventory_mode` - (строка) Режим инвентарных данных. Требуется для операций "Установить режим инвентарных данных узлов сети".

Сообщение операции действия

Объект сообщения операции содержит данные о сообщении, отправляемом этой операцией.

Свойство	Тип	Описание
default_msg	целое число	Использовать ли для действия текст и тему сообщения по умолчанию. Возможные значения: 0 - использовать данные из операции; 1 - (по умолчанию) использовать данные из способа оповещений.
mediatypeid	строка	Идентификатор способа оповещения, который будет использоваться для отправки сообщения.
message	строка	Текст сообщения операции.
subject	строка	Тема сообщения операции.

Условие операции действия

Объект условия операции действия определяет условие, которое должно быть соблюдено для выполнения текущей операции. Он имеет следующие свойства.

Свойство	Тип	Описание
opconditionid	строка	(только чтение) ID условия операции действия
conditiontype (обязательно)	целое число	Тип условия. Возможные значения: 14 - событие подтверждено.
value (обязательно)	строка	Сравниваемое значение.
operationid	строка	(только чтение) ID операции.
operator	целое число	Оператор условия. Возможные значения: 0 - (по умолчанию) =.

Следующие операторы и значения поддерживаются для каждого типа условия операции.

Условие	Имя условия	Поддерживаемые операторы	Ожидаемое значение
14	Событие подтверждено	=	Подтверждено ли событие. Возможные значения: 0 - не подтверждено; 1 - подтверждено.

Операция восстановления действия

Объект операции восстановления действия определяет операцию, выполняемую, когда проблема решена. Операции восстановления возможны для триггерных, внутренних и сервисных действий. Объект имеет следующие характеристики.

Свойство	Тип	Описание
operationid	строка	(только чтение) ID операции действия.
operationtype (обязательно)	целое число	Тип операции. Возможные значения для триггерных и сервисных действий: 0 - отправка сообщения; 1 - глобальный скрипт; 11 - уведомление всех участников. Возможные значения для внутренних действий: 0 - отправить сообщение; 11 - уведомить всех участников.
actionid	строка	(только чтение) ID действия, к которому относится операция восстановления.
opcommand	объект	Объект, содержащий данные о глобальном сценарии действия запускаемом операцией. Каждый объект имеет одно следующее свойство: `scriptid` - (string) ID сценария типа действия. Требуется для операций глобальных сценариев.
opcommand_grp	массив	Группы узлов сети для запуска глобальных сценариев. Каждый объект имеет следующие свойства: `opcommand_grpid` - (строка, только чтение) ID объекта; `operationid` - (строка, только чтение) ID операции; `groupid` - (строка) ID группы узлов сети. Требуется для операций глобальных сценариев, если `opcommand_hst` не установлено.
opcommand_hst	массив	Узел сети для запуска глобальных сценариев. Каждый объект имеет следующие свойства: `opcommand_hstid` - (строка, только чтение) ID объекта; `operationid` - (строка, только чтение) ID операции; `hostid` - (строка) ID узла сети; если установлено значение 0, команда будет запущена на текущем узле сети. Требуется для операций глобальных сценариев, если `opcommand_grp` не задано.
opmessage	объект	Объект, содержащий данные о сообщении, отправляемом операцией восстановления. Объект сообщения операции подробно описан выше. Требуется для операций с сообщениями.
opmessage_grp	массив	Группы пользователей для отправки сообщений. Каждый объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `usrgrpid` - (строка) ID группы пользователей. Требуется для операций с сообщениями если `opmessage_usr` не установлен.
opmessage_usr	массив	Пользователи, которым нужно отправить сообщения. Каждый объект имеет следующие свойства: `operationid` - (строка, только чтение) ID операции; `userid` - (строка) ID пользователя. Требуется для операций с сообщениями если `opmessage_grp` не установлен.

Операция обновления действия

Объект операции обновления действия определяет операцию, которая будет выполняться при обновлении проблемы (прокомментировано, подтверждено, изменена важность или закрыто вручную). Операции обновления возможны для триггерных и сервисных действий. Объект обладает следующими свойствами.

Свойство	Тип	Описание
operationid	строка	(только чтение) ID операции действия.
operationtype (обязательно)	целое число	Тип операции. Возможные значения для триггерных и сервисных действий: 0 - отправить сообщение; 1 - глобальный сценарий; 12 - уведомить всех участников.
opcommand	объект	Объект, содержащий данные о глобальном сценарии, запускаемом операцией. Каждый объект имеет одно следующее свойство: `scriptid` - (string) ID сценария типа действия. Требуется для операций глобальных сценариев.
opcommand_grp	массив	Группы узлов сети для запуска глобальных сценариев. Каждый объект имеет следующие свойства: `groupid` - (string) ID группы узлов сети. Требуется для операций глобальных сценариев, если `opcommand_hst` не установлен.
opcommand_hst	массив	Узлы сети для запуска глобальных сценариев. Каждый объект имеет следующие свойства: `hostid` - (string) ID узла сети; если установлено значение 0, команда будет запущена на текущем хосте. Требуется для операций глобальных сценариев, если `opcommand_grp` не задано.
opmessage	объект	Объект, содержащий данные о сообщении, отправляемом операцией обновления. Объект сообщения операции подробно описан выше.
opmessage_grp	массив	Группы пользователей для отправки сообщений. Каждый объект имеет следующие свойства: `usrgrpid` - (строка) ID группы пользователей. Требуется только для операций `send message` если `opmessage_usr` не установлен. Игнорируется для операций `send update message`.
opmessage_usr	массив	Пользователи которым нужно отправлять сообщения. Каждый объект имеет следующие свойства: `userid` - (строка) ID пользователя. Обязательный только для операций `send message`, если `opmessage_grp` не установлен. Игнорируется для операций `send update message`.

Фильтр действия

Объект фильтра действия определяет набор условий, которые должны быть соблюдены для выполнения настроенных действий. Он имеет следующие свойства.

Свойство	Тип	Описание
conditions (обязательный)	массив	Набор условий фильтрации используемых для фильтрации результатов.
evaltype (обязательный)	целое число	Метод вычисления условий фильтра. Возможные значения: 0 - и/или; 1 - и; 2 - или; 3 - пользовательское выражение.
eval_formula	строка	(только чтение) Сгенерированное выражение, которое будет использоваться для вычисления условий фильтра. Выражение содержит идентификаторы, которые ссылаются на конкретные условия фильтрации по их идентификатору формулы (`formulaid`). Для фильтров с пользовательским выражением значение `eval_formula` равно значению `formula`.
formula	строка	Определенное пользователем выражение, которое будет использоваться для вычисления условий фильтров с пользовательским выражением. Выражение должно содержать идентификаторы, которые ссылаются на определенные условия фильтрации по их `formulaid`. Идентификаторы, используемые в выражении, должны точно совпадать с идентификаторами, определенными в условиях фильтра: ни одно условие не может оставаться неиспользованным или пропущенным. Требуется для настраиваемых выражений фильтров.

Условие фильтра действия

Объект условия фильтра действия определяет конкретное условие, которое необходимо проверить перед выполнением операций действия.

Свойство	Тип	Описание
conditionid	строка	(только чтение) ID условия действия.
conditiontype (обязательно)	целое число	Тип состояния. Возможные значения для триггерных действий: 0 - группа узлов сети; 1 - узел сети; 2 - триггер; 3 - имя триггера; 4 - важность триггера; 6 - период времени; 13 - шаблон узла сети; 16 - проблема подавлена; 25 - тег события; 26 - значение тега события. Возможные значения для действий обнаружения: 7 - IP узла сети; 8 - тип обнаруженной службы; 9 - порт обнаруженной службы; 10 - статус обнаружения; 11 - продолжительность безотказной работы или простоя; 12 - полученное значение; 18 - правило обнаружения; 19 - проверка обнаружения; 20 - прокси; 21 - объект обнаружения. Возможные значения для действий авторегистрации: 20 - прокси; 22 - имя узла сети; 24 - метаданные узла сети. Возможные значения для внутренних действий: 0 - группа узлов сети; 1 - узел сети; 13 - шаблон узла сети; 23 - тип события; 25 - тег события; 26 - значение тега события. Возможные значения для служебных действий: 25 - тег события; 26 - значение тега события; 27 - служба; 28 - название службы.
value (обязательно)	строка	Значение для сравнения.
value2	строка	Вторичное значение для сравнения. Требуется для триггерных, внутренних и сервисных действий, когда тип условия равен 26.
actionid	строка	(только чтение) Идентификатор действия, которому принадлежит условие.
formulaid	строка	Произвольный уникальный идентификатор который используется для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть определен пользователем при изменении условий фильтрации, но будет сгенерирован заново при последующем запросе.
operator	целое число	Оператор условия. Возможные значения: 0 - (по умолчанию) равно; 1 - не равно; 2 - содержит; 3 - не содержит; 4 - в; 5 - больше или равно; 6 - меньше или равно; 7 - не встречается (not in); 8 - совпадает; 9 - не совпадает; 10 - Да; 11 - Нет.

Чтобы лучше понять как использовать фильтры с различными типами выражений, смотрите примеры на страницах методов action.get и action.create.

Для каждого типа условия поддерживаются следующие операторы и значения.

Условие	Название условия	Поддерживаемые операторы	Ожидаемое значение
0	Группа узлов сети	равно, не равно	Идентификатор группы хостов.
1	Узел сети	равен, не равен	Идентификатор узла сети.
2	Триггер	равен, не равен	Идентификатор триггера.
3	Имя триггера	содержит, не содержит	Имя триггера.
4	Важность триггера	равна, не равна, больше или равно, меньше или равно	Важность триггера. Обратитесь к свойству триггера «важность» для получения списка поддерживаемых степеней важности триггера.
5	Значение триггера	равно	Значению триггера. Обратитесь к свойству свойству триггера «значение» для получения списка поддерживаемых значений триггера.
6	Период времени	в, не в (in, not in)	Время, когда событие было запущено в формате период времени.
7	IP узла сети	равно, не равно	Один или несколько диапазонов IP для проверки, разделенных запятыми. Обратитесь к разделу конфигурация обнаружения сети для получения дополнительной информации о поддерживаемых форматах диапазонов IP.
8	Тип обнаруженной службы	равен, не равен	Тип обнаруженной службы. Тип службы соответствует типу проверки обнаружения, используемой для нахождения службы. Обратитесь к свойству проверки обнаружения "тип" для получения списка поддерживаемых типов.
9	Порт обнаруженной службы	равен, не равен	Однин или несколько диапазонов портов, разделенные запятыми.
10	Статус обнаружения	равно	Статус обнаруженного объекта. Возможные значения: 0 - узел сети или служба подключены; 1 - Узел сети или служба отключены; 2 - узел сети или служба обнаружены; 3 - Узел сети или служба потеряны.
11	Продолжительность безотказной работы или простоя	больше или равно, меньше или равно	Время (в секундах), указывающее, как долго обнаруженный объект находится в текущем состоянии.
12	Полученные значения	равно, не равно, больше или равно, меньше или равно, содержит, не содержит	Значение, возвращаемое при выполнении проверки обнаружения агента Zabbix, SNMPv1, SNMPv2 или SNMPv3.
13	Шаблон хоста	равен, не равен	Идентификатор связанного шаблона.
16	Проблема подавлена	Да, Нет	Значение не требуется: использование оператора «Да» означает, что проблема должна быть подавлена, «Нет» -- не подавлена.
18	Правило обнаружения	равно, не равно	Идентификатор правила обнаружения.
19	Проверка обнаружения	равно, не равно	Идентификатор проверки обнаружения.
20	Прокси	равно, не равно	Идентификатор прокси.
21	Объект обнаружения	равно	Тип объекта который вызвал событие обнаружения. Возможные значения: 1 - обнаружен узел сети; 2 - обнаружена служба.
22	Имя узла сети	содержит, не содержит, соответствует, не соответствует	Имя узла сети. Использование регулярного выражения поддерживается для операторов совпадает и не совпадает в условиях авторегистрации.
23	Тип события	равно	Конкретное внутреннее событие. Возможные значения: 0 - элемент данных в состоянии «не поддерживается»; 1 - элемент данных в «нормальном» состоянии; 2 - правило LLD в состоянии «не поддерживается»; 3 - правило LLD в «нормальном» состоянии; 4 - триггер в «неизвестном» состоянии; 5 - триггер в «нормальном» состоянии.
24	Метаданные узла сети	содержит, не содержит, соответствует, не соответствует	Метаданные автоматически зарегистрированного узла сети. Использование регулярного выражения поддерживается для операторов совпадает и не совпадает.
25	Тег	равен, не равен, содержит, не содержит	тег события.
26	Значение тега	равно, не равно, содержит, не содержит	Значение тега события.
27	Служба	равно, не равно	Идентификатор службы.
28	Имя службы	равно, не равно	Имя службы.

Documentation