Наступні об’єкти безпосередньо пов’язані з action
API.
Об'єкт дії має такі властивості.
Властивість | Тип | Опис |
---|---|---|
actionid | string | (лише читання) ID дії. |
esc_period (обов'язково) |
string | Тривалість кроку операції за замовчуванням. Має бути не менше 60 секунд. Приймає секунди, одиницю вимірювання часу з суфіксом і макрос користувача. Зауважте, що ескалація підтримується лише для тригерів, внутрішніх і службових дій і лише в звичайних операціях. |
eventsource (обов’язково) |
integer | (константа) Тип подій, які дія оброблятиме. Зверніться до event "source" property для списку підтримуваних типів подій. |
name (обов'язково) |
string | Назва дії. |
status | integer | Увімкнено чи вимкнено дію. Можливі значення: 0 - (за замовчуванням) увімкнено; 1 - вимкнено. |
pause_suppressed | integer | Чи призупинити ескалацію під час періодів обслуговування чи ні. Можливі значення: 0 - Не призупиняти ескалацію; 1 - (за замовчуванням) Призупинити ескалацію. Зверніть увагу, що цей параметр дійсний лише для тригерних дій. |
notify_if_canceled | integer | Чи сповіщати, коли ескалацію скасовано. Можливі значення: 0 - Не повідомляти, коли ескалацію скасовано; 1 - (за замовчуванням) Повідомляти, коли ескалацію скасовано. Зверніть увагу, що цей параметр дійсний лише для дій ініціатора. |
Зауважте, що для деяких методів (оновлення, видалення) комбінація обов’язкових/необов’язкових параметрів відрізняється.
Об’єкт операції дії визначає операцію, яка виконуватиметься під час виконання дії. Має такі властивості.
Властивість | Тип | Опис |
---|---|---|
operationid | string | (readonly) ID операції дії. |
operationtype (обов'язково) |
integer | Тип операції. Можливі значення: 0 - надіслати повідомлення; 1 - глобальний сценарій; 2 - додати хост; 3 - видалити хост; 4 - додати до групи хостів; 5 - видалити з групи хостів; 6 - посилання на шаблон; 7 - видалити зв'язок із шаблоном;<br >8 - увімкнути хост; 9 - вимкнути хост; 10 - встановити режим інвентаризації хоста. Зауважте, що лише типи «0» і «1» підтримуються для тригерів і дій служби, лише «0» підтримується для внутрішніх дій. Усі типи підтримуються для дій виявлення та автореєстрації. |
actionid | string | (лише для читання) ID дії, до якої належить операція. |
esc_period | string | Тривалість кроку ескалації в секундах. Має бути більше 60 секунд. Приймає секунди, одиниці вимірювання часу з суфіксом і макрос користувача. Якщо встановлено значення 0 або 0 с, використовуватиметься період ескалації дії за замовчуванням. За замовчуванням: 0 с. Зверніть увагу, що ескалація підтримується лише для ініціаторів, внутрішніх і службових дій і лише у звичайному режимі. операцій. |
esc_step_from | integer | Крок, з якого починається ескалація. За замовчуванням: 1. Зауважте, що ескалація підтримується лише для ініціаторів, внутрішніх і службових дій і лише під час звичайних операцій . |
esc_step_to | integer | Крок для завершення ескалації. За замовчуванням: 1. Зауважте, що ескалація підтримується лише для ініціаторів, внутрішніх і службових дій і лише під час звичайних операцій . |
evaltype | integer | Метод оцінки умови операції. Можливі значення: 0 - (за замовчуванням) І / АБО; 1 - І; 2 - АБО. |
opcommand | object | Об’єкт, що містить дані про глобальний сценарій, запущений операцією. Кожен об’єкт має таку властивість: scriptid - (string) ідентифікатор сценарію.Обов’язково для глобальних операцій сценарію. |
opcommand_grp | array | Групи хостів для запуску глобальних сценаріїв. Кожен об'єкт має такі властивості: opcommand_grpid - (string, readonly) ідентифікатор об'єкта;operationid - (string, readonly) ID операції;groupid - (string) ID групи хостів.Потрібно для операцій глобального сценарію, якщо opcommand_hst є не встановлено. |
opcommand_hst | array | Хост для запуску глобальних сценаріїв. Кожен об’єкт має такі властивості: opcommand_hstid - (string, readonly) ідентифікатор об’єкта;operationid - (string, readonly) ID операції;hostid - (string) ID хоста; якщо встановлено значення 0, команда буде виконана на поточному хості.Потрібно для операцій глобального сценарію, якщо opcommand_grp не встановлено. |
opconditions | array | Умови роботи, що використовуються для дій ініціатора. Об’єкт умови операції докладно описано нижче. |
opgroup | array | Групи хостів для додавання хостів. Кожен об'єкт має такі властивості: operationid - (string, readonly) ID операції;groupid - (string) ID групи хостів.Потрібно для операцій «додати до групи хостів» і «видалити з групи хостів». |
opmessage | object | Об’єкт, що містить дані про повідомлення, надіслане операцією. Об’єкт повідомлення про операцію докладно описано нижче.< br Потрібно для операцій з повідомленнями. |
opmessage_grp | array | Групи користувачів для надсилання повідомлень. Кожен об’єкт має такі властивості: operationid - (string, readonly) ID операції;usrgrpid - (string) ID групи користувачів.Потрібно для операцій з повідомленнями, якщо opmessage_usr не встановлено. |
opmessage_usr | масив | Користувачі для надсилання повідомлень. Кожен об’єкт має такі властивості: operationid - (string, readonly) ID операції;userid - (string) ID користувача.Потрібно для операцій з повідомленнями, якщо opmessage_grp не встановлено. |
optemplate | array | Шаблони для зв’язування хостів. Кожен об’єкт має такі властивості: operationid - (string, readonly) ID операції;templateid - (string) Ідентифікатор шаблону.Потрібно для операцій «посилання на шаблон» і «від’єднання від шаблону». |
opinventory | object | Режим інвентаризації встановлено для хоста. Об’єкт має такі властивості: operationid - (string, readonly) ідентифікатор операції;inventory_mode - * (string)* Режим інвентаризації.Потрібен для операцій «Установити режим інвентаризації хоста». |
Об'єкт повідомлення операції містить дані про повідомлення, яке буде надіслано операцією.
Властивість | Тип | Опис |
---|---|---|
default_msg | integer | Чи використовувати текст і тему повідомлення про дію за замовчуванням. Можливі значення: 0 - використовувати дані з операції; 1 - (за замовчуванням) використовувати дані з способу оповіщення. |
mediatypeid | string | Ідентифікатор способу оповіщення, який буде використано для надсилання повідомлення. |
message | string | Текст повідомлення операції. |
subject | string | Тема повідомлення операції. |
Об’єкт операції дії визначає умову, яка має бути виконана для виконання поточної операції. Має такі властивості.
Властивість | Тип | Опис |
---|---|---|
opconditionid | string | (readonly) ID умови операції дії |
conditiontype (обов’язково) |
integer | Тип умови. Можливі значення: 14 - подія підтверджена. |
value (обов’язково) |
string | Значення для порівняння. |
operationid | string | (readonly) ID операції. |
operator | integer | Оператор умови. Можливі значення: 0 - (default) =. |
Наступні оператори та значення підтримуються для кожного типу умови операції.
Умова | Назва умови | Підтримувані оператори | Очікуване значення |
---|---|---|---|
14 | Подію підтверджено | = | Чи підтверджено подію. Можливі значення: 0 - не підтверджено; 1 - підтверджено. |
Об'єкт операції відновлення дії визначає операцію, яка буде виконана після вирішення проблеми. Операції відновлення можливі для тригерних, внутрішніх і службових дій. Має такі властивості.
Властивість | Тип | Опис |
---|---|---|
operationid | string | (read only) ID операції дії. |
operationtype (обов’язково) |
integer | Тип операції. Можливі значення для тригерів і дій служби: 0 - надіслати повідомлення; 1 - глобальний сценарій; 11 - повідомити всіх учасників. Можливі значення для внутрішніх дій: 0 - надіслати повідомлення; 11 - повідомити всіх учасників. |
actionid | string | (read only) Ідентифікатор дії, до якої належить операція відновлення. |
opcommand | object | Об’єкт, що містить дані про глобальний сценарій типу дії, який виконується операцією. Кожен об’єкт має одну таку властивість: scriptid - (string) ID сценарію типу дії.Потрібно для глобальних операцій сценаріїв. |
opcommand_grp | масив | Групи хостів для запуску глобальних сценаріїв. Кожен об'єкт має такі властивості: opcommand_grpid - (string, read only) ідентифікатор об'єкта;operationid - (string, readonly) ID операції;groupid - (string) ID групи хостів.Потрібен для глобальних операцій скрипта, якщо opcommand_hst не встановлено. |
opcommand_hst | масив | Хост для запуску глобальних сценаріїв. Кожен об’єкт має такі властивості: opcommand_hstid - (string, read only) ідентифікатор об’єкта;operationid - (string, readonly) ID операції;hostid - (string) ID хоста; якщо встановлено значення 0, команда буде виконана на поточному хості.Потрібно для операцій глобального сценарію, якщо opcommand_grp не встановлено. |
opmessage | object | Об’єкт, що містить дані про повідомлення, надіслане операцією відновлення. Об’єкт повідомлення операції докладно описано вище. Потрібно для операцій з повідомленнями. |
opmessage_grp | масив | Групи користувачів для надсилання повідомлень. Кожен об’єкт має такі властивості: operationid - (string, read only) ID операції;usrgrpid - (string) ID групи користувачів.Потрібно для операцій з повідомленнями, якщо opmessage_usr не встановлено. |
opmessage_usr | масив | Користувачі для надсилання повідомлень. Кожен об’єкт має такі властивості: operationid - (string, read only) ID операції;userid - (string) ID користувача.Потрібно для операцій з повідомленнями, якщо opmessage_grp не встановлено. |
Об’єкт операції оновлення дії визначає операцію, яка виконуватиметься, коли проблему буде оновлено (прокоментовано, підтверджено, змінено серйозність або закрито вручну). Операції оновлення можливі для дій тригера та служби. Має такі властивості.
Властивість | Тип | Опис |
---|---|---|
operationid | string | (readonly) ID операції дії. |
operationtype (обов’язково) |
integer | Тип операції. Можливі значення для тригерів і дій служби: 0 - надіслати повідомлення; 1 - глобальний сценарій; 12 - повідомити всіх причетних. |
opcommand | object | Об’єкт, що містить дані про сценарій типу глобальної дії, який виконується операцією. Кожен об’єкт має одну наступну властивість: scriptid - (string) ID сценарію типу дії.Потрібно для глобальних операцій сценаріїв. |
opcommand_grp | array | Групи хостів для запуску глобальних сценаріїв. Кожен об’єкт має такі властивості: groupid - (string) ID групи хостів.Потрібно для глобальних операцій сценаріїв, якщо opcommand_hst не встановлено. |
opcommand_hst | array | Хост для запуску глобальних сценаріїв. Кожен об'єкт має такі властивості: hostid - (string) ID хоста; якщо встановлено значення 0, команда буде виконана на поточному хості.Потрібно для операцій глобального сценарію, якщо opcommand_grp не встановлено. |
opmessage | object | Об’єкт, що містить дані про повідомлення, надіслане операцією оновлення. Об’єкт повідомлення про операцію докладно описано вище. |
opmessage_grp | array | Групи користувачів для надсилання повідомлень. Кожен об’єкт має такі властивості: usrgrpid - (string) ID групи користувачів.<br >Потрібно лише для операцій надіслати повідомлення , якщо opmessage_usr не встановлено.Ігнорується для операцій надіслати повідомлення оновлення . |
opmessage_usr | array | Користувачі для надсилання повідомлень. Кожен об’єкт має такі властивості: userid - (string) ідентифікатор користувача.Обов’язково лише для операцій надіслати повідомлення , якщо opmessage_grp не встановлено.Ігнорується для операцій надіслати повідомлення оновлення . |
Об’єкт фільтра дій визначає набір умов, які мають бути виконані для виконання налаштованих операцій дій. Має такі властивості.
Властивість | Тип | Опис |
---|---|---|
conditions (обов’язково) |
array | Набір умов фільтра для використання для фільтрації результатів. |
evaltype (обов’язково) |
integer | Метод оцінки умови фільтра. Можливі значення: 0 - та/або; 1 - і; 2 - або; 3 - спеціальний вираз. |
eval_formula | string | (лише для читання) Згенерований вираз, який використовуватиметься для оцінки умов фільтра. Вираз містить ідентифікатори, які посилаються на конкретні умови фільтра за його formulaid . Значення eval_formula дорівнює значенню formula для фільтрів із спеціальним виразом. |
formula | string | Визначений користувачем вираз, який буде використовуватися для оцінки умов фільтрів за допомогою спеціального виразу. Вираз має містити ідентифікатори, які посилаються на конкретні умови фільтра за його formulaid . Ідентифікатори, які використовуються у виразі, мають точно відповідати ідентифікаторам, визначеним в умовах фільтра: жодна умова не може залишатися невикористаною або пропущеною.Потрібно для фільтрів користувацьких виразів. |
Об’єкт умови фільтра дій визначає певну умову, яку необхідно перевірити перед виконанням операцій дії.
Властивість | Тип | Опис |
---|---|---|
conditionid | string | (лише для читання) ID умови дії. |
conditiontype (обов’язково) |
integer | Тип умови. Можливі значення для тригерних дій: 0 - група хостів; 1 - хост; 2 - тригер; 3 - ім'я тригера; 4 - серйозність тригера; 6 - період часу; 13 - шаблон хосту; 16 - проблема припинена; 25 - подія тег; 26 - значення тегу події. Можливі значення для дій виявлення: 7 - IP хоста; 8 - виявлений тип служби; 9 - виявлений порт служби; 10 - статус виявлення; 11 - тривалість роботи або простою; 12 - отримане значення; 18 - правило виявлення; 19 - перевірка виявлення; 20 - проксі;<br >21 - об'єкт виявлення. Можливі значення для дій автореєстрації: 20 - проксі; 22 - ім'я хоста; 24 - метадані хоста. Можливі значення для внутрішні дії: 0 - група хостів; 1 - хост; 13 - шаблон хосту; 23 - тип події; 25 - тег події; 26 - значення тегу події . Можливі значення для дій служби: 25 - тег події; 26 - значення тегу події; 27 - послуга; 28 - назва служби. |
value (обов’язково) |
string | Значення для порівняння. |
value2 |
string | Вторинне значення для порівняння. Необхідний для тригерів, внутрішніх і службових дій, коли тип умови 26. |
actionid | string | (лише для читання) ID дії, до якої належить умова. |
formulaid | string | Довільний унікальний ідентифікатор, який використовується для посилання на умову з користувацького виразу. Може містити лише великі літери. Ідентифікатор має бути визначений користувачем під час зміни умов фільтра, але буде згенеровано заново під час їхнього запиту пізніше. |
operator | integer | Оператор умови. Можливі значення: 0 - (за замовчуванням) дорівнює; 1 - не дорівнює; 2 - містить; 3 - не містить; 4 - в; 5 - більше або дорівнює; 6 - менше або дорівнює; 7 - не в; 8 - збігається;<br >9 - не відповідає; 10 - Так; 11 - Ні. |
Щоб краще зрозуміти, як використовувати фільтри з різними типами виразів, перегляньте приклади на сторінках методів action.get і action.create.
Наступні оператори та значення підтримуються для кожного типу умови.
Умова | Назва умови | Підтримувані оператори | Очікуване значення |
---|---|---|---|
0 | Група вузлів мережі | дорівнює, не дорівнює |
Ідентифікатор групи вузлів мережі. |
1 | Вузол мережі | дорівнює, не дорівнює |
Ідентифікатор вузла мережі. |
2 | Тригер | дорівнює, не дорівнює |
Ідентифікатор тригера. |
3 | Ім'я тригера | містить, не містить |
Ім'я тригера. |
4 | Важливість тригера | дорівнює, не дорівнює, більша або дорівнює, менша або дорівнює |
Важливість тригера. Перегляньте властивість "важливості" тригера, щоб отримати список підтримуваних рівнів важливості тригера. |
5 | Значення тригера | дорівнює | Значення тригера. Перегляньте властивість "значення" тригера, щоб переглянути список підтримуваних значень тригера. |
6 | Період часу | в, не в | Час, коли подію було спровоковано як період часу. |
7 | IP вузла мережі | дорівнює, не дорівнює |
Один або кілька діапазонів IP для перевірки, розділених комами. Зверніться до розділу конфігурація виявлення мережі, щоб дізнатися більше про підтримувані формати діапазонів IP-адрес. |
8 | Тип виявлення послуги | дорівнює, не дорівнює |
Типу виявленя послуги. Тип служби відповідає типу перевірки виявлення, яка використовується для виявлення послуги. Перегляньте властивість "тип" перевірки виявлення, щоб переглянути список підтримуваних типів. |
9 | Порт виявлення послуги | дорівнює, не дорівнює |
Один або кілька діапазонів портів, розділених комами. |
10 | Статус виявлення | дорівнює | Статусу виявленого об'єкта. Можливі значення: 0 - хост або служба працює; 1 - хост або служба не працює; 2 - хост або службу виявлено; 3 - хост або послугу втрачено. |
11 | Тривалість безвідмовної роботи або простою | більше або дорівнює, менше або дорівнює |
Час, що вказує, як довго виявлений об’єкт перебував у поточному статусі в секундах. |
12 | Отримані значення | дорівнює, не дорівнює, більше або дорівнює, менше або дорівнює, містить, не містить |
Значення, що повертається під час виконання Агент Zabbix, перевірка виявлення SNMPv1, SNMPv2 або SNMPv3. |
13 | Шаблон хосту | дорівнює, не дорівнює |
Ідентифікатор пов’язаного шаблону. |
16 | Проблема прихована | Так, Ні | Значення не обов'язкове: використання оператора "Так" означає, що проблему потрібно придушити, "Ні" - не придушувати. |
18 | Правило виявлення | дорівнює, не дорівнює |
ID правила відкриття. |
19 | Перевірка виявлення | дорівнює, не дорівнює |
ID перевірки виявлення. |
20 | Проксі | дорівнює, не дорівнює |
ID проксі. |
21 | Об'єкт виявлення | дорівнює | Тип |