На странице
Объект прототипа элемента данных
Следующие объекты напрямую связаны с API itemprototype.
Прототип элемента данных
Объект прототипа элемента данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| itemid | ID | ID прототипа элемента данных. Поведение свойства: - только для чтения - обязательно для операций обновления |
| delay | string | Интервал обновления прототипа элемента данных. Принимает количество секунд (например, 1, 60, 300), значение с суффиксом времени (например, 30s, 1m, 2h, 1d) или, опционально, один или несколько пользовательских интервалов, разделённых точками с запятой. Пользовательские интервалы могут представлять собой комбинацию гибких интервалов и интервалов расписания.Поддерживает пользовательские макросы и макросы LLD. При использовании значение должно состоять из одного макроса. Несколько макросов или макросы, смешанные с текстом, не поддерживаются. Гибкие интервалы можно записывать как два макроса, разделённых косой чертой (например, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Пример: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Поведение свойства: - обязательно, если type имеет значение "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22) или если type имеет значение "Zabbix agent (active)" (7), а key_ не содержит "mqtt.get" |
| hostid | ID | ID узла сети, которому принадлежит прототип элемента данных. Поведение свойства: - константа - обязательно для операций создания |
| interfaceid | ID | ID интерфейса узла сети прототипа элемента данных. Поведение свойства: - обязательно, если прототип элемента данных принадлежит узлу сети, а type имеет значение "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" или "SNMP agent"- поддерживается, если прототип элемента данных принадлежит узлу сети, а type имеет значение "Simple check", "External check", "SSH agent", "TELNET agent" или "HTTP agent" |
| key_ | string | Ключ прототипа элемента данных. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов |
| name | string | Имя прототипа элемента данных. Поддерживает пользовательские макросы. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов |
| type | integer | Тип прототипа элемента данных. Возможные значения: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов |
| url | string | Строка URL. Поддерживает макросы LLD, пользовательские макросы, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Поведение свойства: - обязательно, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| value_type | integer | Тип информации прототипа элемента данных. Возможные значения: 0 - числовой с плавающей запятой; 1 - символьный; 2 - журнал; 3 - числовой без знака; 4 - текстовый; 5 - двоичный. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов |
| allow_traps | integer | Разрешить заполнение значения аналогично элементу данных типа trapper. 0 - (по умолчанию) не принимать входящие данные; 1 - разрешить приём входящих данных. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent" |
| authtype | integer | Метод аутентификации. Возможные значения, если type имеет значение "SSH agent":0 - (по умолчанию) пароль; 1 - открытый ключ. Возможные значения, если type имеет значение "HTTP agent":0 - (по умолчанию) отсутствует; 1 - базовая; 2 - NTLM; 3 - Kerberos; 4 - Digest. Поведение свойства: - поддерживается, если type имеет значение "SSH agent" или "HTTP agent"- только для чтения для унаследованных объектов (если type имеет значение "HTTP agent") |
| description | string | Описание прототипа элемента данных. |
| flags | integer | Источник прототипа элемента данных. Возможные значения: 2 - прототип элемента данных; 6 - обнаруженный прототип элемента данных Поведение свойства: - только для чтения |
| follow_redirects | integer | Следовать перенаправлениям ответа при опросе данных. Возможные значения: 0 - не следовать перенаправлениям; 1 - (по умолчанию) следовать перенаправлениям. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| headers | array | Массив заголовков, отправляемых при выполнении HTTP-запроса. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| history | string | Единица времени, определяющая срок хранения данных истории. Также поддерживает пользовательский макрос и макрос LLD. По умолчанию: 31d. |
| http_proxy | string | Строка подключения к прокси HTTP(S). Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| ipmi_sensor | string | Датчик IPMI. Поведение свойства: - обязательно, если type имеет значение "IPMI agent", а key_ не имеет значения "ipmi.get"- поддерживается, если type имеет значение "IPMI agent"- только для чтения для унаследованных объектов |
| jmx_endpoint | string | Пользовательская строка подключения агента JMX. По умолчанию: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Поведение свойства: - поддерживается, если type имеет значение "JMX agent" |
| logtimefmt | string | Формат времени в записях журнала. Поведение свойства: - поддерживается, если value_type имеет значение "log"- только для чтения для унаследованных объектов |
| master_itemid | ID | ID главного элемента данных. Поведение свойства: - обязательно, если type имеет значение "Dependent item"- только для чтения для унаследованных объектов |
| output_format | integer | Следует ли преобразовать ответ в JSON. Возможные значения: 0 - (по умолчанию) сохранять как есть; 1 - преобразовать в JSON. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| params | string | Дополнительные параметры в зависимости от типа прототипа элемента данных: - выполняемый скрипт для прототипов элементов данных SSH agent и TELNET agent; - SQL-запрос для прототипов элементов данных Database monitor; - формула для прототипов вычисляемых элементов данных; - скрипт для прототипов элементов данных Script и Browser. Поведение свойства: - обязательно, если type имеет значение "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" или "Browser"- только для чтения для унаследованных объектов (если type имеет значение "Script" или "Browser") |
| parameters | object/array | Дополнительные параметры, если type имеет значение "Script" или "Browser". Массив объектов со свойствами name и value, где name должен быть уникальным.Поведение свойства: - поддерживается, если type имеет значение "Script" или "Browser"- только для чтения для унаследованных объектов |
| password | string | Пароль для аутентификации. Поведение свойства: - обязательно, если type имеет значение "JMX agent", а username задан- поддерживается, если type имеет значение "Simple check", "SSH agent", "TELNET agent", "Database monitor" или "HTTP agent"- только для чтения для унаследованных объектов (если type имеет значение "HTTP agent") |
| post_type | integer | Тип тела данных POST, хранящегося в свойстве posts.Возможные значения: 0 - (по умолчанию) необработанные данные; 2 - данные JSON; 3 - данные XML. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| posts | string | Данные тела HTTP(S)-запроса. Поведение свойства: - обязательно, если type имеет значение "HTTP agent", а post_type имеет значение "JSON data" или "XML data"- поддерживается, если type имеет значение "HTTP agent", а post_type имеет значение "Raw data"- только для чтения для унаследованных объектов |
| privatekey | string | Имя файла закрытого ключа. Поведение свойства: - обязательно, если type имеет значение "SSH agent", а authtype имеет значение "public key" |
| publickey | string | Имя файла открытого ключа. Поведение свойства: - обязательно, если type имеет значение "SSH agent", а authtype имеет значение "public key" |
| query_fields | array | Массив полей запроса, отправляемых при выполнении HTTP-запроса. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| request_method | integer | Тип метода запроса. Возможные значения: 0 - (по умолчанию) GET; 1 - POST; 2 - PUT; 3 - HEAD. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| retrieve_mode | integer | Какая часть ответа должна сохраняться. Возможные значения, если request_method имеет значение "GET", "POST" или "PUT":0 - (по умолчанию) тело; 1 - заголовки; 2 - сохранять тело и заголовки. Возможные значения, если request_method имеет значение "HEAD":1 - заголовки. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| snmp_oid | string | OID SNMP. Поведение свойства: - обязательно, если type имеет значение "SNMP agent"- только для чтения для унаследованных объектов |
| ssl_cert_file | string | Путь к файлу открытого ключа SSL. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| ssl_key_file | string | Путь к файлу закрытого ключа SSL. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| ssl_key_password | string | Пароль для файла ключа SSL. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| status | integer | Состояние прототипа элемента данных. Возможные значения: 0 - (по умолчанию) прототип элемента данных включён; 1 - прототип элемента данных отключён; 3 - прототип элемента данных не поддерживается. |
| status_codes | string | Диапазоны требуемых кодов состояния HTTP, разделённые запятыми. Также поддерживает пользовательские макросы или макросы LLD как часть списка, разделённого запятыми. Пример: 200,200-{$M},{$M},200-400 Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| templateid | ID | ID прототипа элемента данных родительского шаблона. Поведение свойства: - только для чтения |
| timeout | string | Тайм-аут запроса на опрос данных элемента данных. Принимает количество секунд (например, 1, 60) или значение с суффиксом времени (например, 30s, 1m). Также поддерживает пользовательские макросы и макросы LLD.Допустимый диапазон значений: 1-600s. По умолчанию: "" - использовать настройки прокси/глобальные настройки. Поведение свойства: - поддерживается, если type имеет значение "Zabbix agent" (0), "Simple check" (3), а key_ не начинается с "vmware." и "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20), а snmp_oid начинается с "walk[" или "get[", "Script" (21), "Browser" (22)- только для чтения для унаследованных объектов |
| trapper_hosts | string | Разрешённые узлы сети. Поведение свойства: - поддерживается, если type имеет значение "Zabbix trapper" или если type имеет значение "HTTP agent", а allow_traps имеет значение "Allow to accept incoming data" |
| trends | string | Единица времени, определяющая срок хранения данных трендов. Также поддерживает пользовательский макрос и макрос LLD. По умолчанию: 365d. Поведение свойства: - поддерживается, если value_type имеет значение "numeric float" или "numeric unsigned" |
| units | string | Единицы измерения значения. Поведение свойства: - поддерживается, если value_type имеет значение "numeric float" или "numeric unsigned"- только для чтения для унаследованных объектов |
| username | string | Имя пользователя для аутентификации. Поведение свойства: - обязательно, если type имеет значение "SSH agent" или "TELNET agent", либо если type имеет значение "JMX agent", а password задан- поддерживается, если type имеет значение "Simple check", "Database monitor" или "HTTP agent"- только для чтения для унаследованных объектов (если type имеет значение "HTTP agent") |
| uuid | string | Универсальный уникальный идентификатор, используемый для связывания импортированных прототипов элементов данных с уже существующими. Создаётся автоматически, если не указан. Поведение свойства: - поддерживается, если прототип элемента данных принадлежит шаблону |
| valuemapid | ID | ID связанной карты значений. Поведение свойства: - поддерживается, если value_type имеет значение "numeric float", "character" или "numeric unsigned"- только для чтения для унаследованных объектов |
| verify_host | integer | Проверять ли соответствие имени узла сети для подключения имени, указанному в сертификате узла сети. Возможные значения: 0 - (по умолчанию) не проверять; 1 - проверять. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| verify_peer | integer | Проверять ли подлинность сертификата узла сети. Возможные значения: 0 - (по умолчанию) не проверять; 1 - проверять. Поведение свойства: - поддерживается, если type имеет значение "HTTP agent"- только для чтения для унаследованных объектов |
| discover | integer | Состояние обнаружения прототипа элемента данных. Возможные значения: 0 - (по умолчанию) новые элементы данных будут обнаруживаться; 1 - новые элементы данных обнаруживаться не будут, а существующие элементы данных будут помечены как потерянные. |
HTTP-заголовок
Объект заголовка имеет следующие свойства:
| Property | Type | Description |
|---|---|---|
| name | string | Имя HTTP-заголовка. Поведение свойства: - required |
| value | string | Значение заголовка. Поведение свойства: - required |
Поле HTTP-запроса
Объект поля запроса определяет имя и значение, которые используются для указания параметра URL. Он имеет следующие свойства:
| Property | Type | Description |
|---|---|---|
| name | string | Имя параметра. Property behavior: - required |
| value | string | Значение параметра. Property behavior: - required |
Тег прототипа элемента данных
Объект тега прототипа элемента данных имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| tag | string | Имя тега прототипа элемента данных. Поведение свойства: - required |
| value | string | Значение тега прототипа элемента данных. |
Предобработка прототипа элемента данных
Объект предобработки прототипа элемента данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| type | integer | Тип параметра предобработки. Возможные значения: 1 - Пользовательский множитель; 2 - Удаление символов справа; 3 - Удаление символов слева; 4 - Удаление символов с обеих сторон; 5 - Регулярное выражение; 6 - Преобразование логического значения в десятичное; 7 - Преобразование восьмеричного числа в десятичное; 8 - Преобразование шестнадцатеричного числа в десятичное; 9 - Простое изменение; 10 - Изменение в секунду; 11 - XML XPath; 12 - JSONPath; 13 - В диапазоне; 14 - Соответствует регулярному выражению; 15 - Не соответствует регулярному выражению; 16 - Проверка наличия ошибки в JSON; 17 - Проверка наличия ошибки в XML; 18 - Проверка наличия ошибки с помощью регулярного выражения; 19 - Отбрасывать неизменившиеся значения; 20 - Отбрасывать неизменившиеся значения с контрольным интервалом; 21 - JavaScript; 22 - Шаблон Prometheus; 23 - Преобразование Prometheus в JSON; 24 - Преобразование CSV в JSON; 25 - Замена; 26 - Проверка неподдерживаемого значения; 27 - Преобразование XML в JSON; 28 - Значение SNMP walk; 29 - Преобразование SNMP walk в JSON; 30 - Значение SNMP get. Поведение свойства: - обязательное |
| params | string | Дополнительные параметры, используемые параметром предобработки. Несколько параметров разделяются символом новой строки (\n). Если для type установлено значение «Проверка неподдерживаемого значения», параметры соответствуют синтаксису <scope>[\n<pattern>], где pattern - регулярное выражение, а scope принимает одно из следующих значений:-1 - соответствует любой ошибке; \ 0 - проверять, соответствует ли сообщение об ошибке шаблону pattern; \ 1 - проверять, не соответствует ли сообщение об ошибке шаблону pattern. Поведение свойства: - обязательное, если для type установлено значение «Пользовательский множитель» (1), «Удаление символов справа» (2), «Удаление символов слева» (3), «Удаление символов с обеих сторон» (4), «Регулярное выражение» (5), «XML XPath» (11), «JSONPath» (12), «В диапазоне» (13), «Соответствует регулярному выражению» (14), «Не соответствует регулярному выражению» (15), «Проверка наличия ошибки в JSON» (16), «Проверка наличия ошибки в XML» (17), «Проверка наличия ошибки с помощью регулярного выражения» (18), «Отбрасывать неизменившиеся значения с контрольным интервалом» (20), «JavaScript» (21), «Шаблон Prometheus» (22), «Преобразование Prometheus в JSON» (23), «Преобразование CSV в JSON» (24), «Замена» (25), «Проверка неподдерживаемого значения» (26), «Значение SNMP walk» (28), «Преобразование SNMP walk в JSON» (29) или «Значение SNMP get» (30) |
| error_handler | integer | Тип действия в случае сбоя шага предобработки. Возможные значения: 0 - Сообщение об ошибке устанавливается сервером Zabbix; 1 - Отбросить значение; 2 - Установить пользовательское значение; 3 - Установить пользовательское сообщение об ошибке. Возможные значения, если для type установлено значение «Проверка неподдерживаемого значения»:1 - Отбросить значение; 2 - Установить пользовательское значение; 3 - Установить пользовательское сообщение об ошибке. Поведение свойства: - обязательное, если для type установлено значение «Пользовательский множитель» (1), «Регулярное выражение» (5), «Преобразование логического значения в десятичное» (6), «Преобразование восьмеричного числа в десятичное» (7), «Преобразование шестнадцатеричного числа в десятичное» (8), «Простое изменение» (9), «Изменение в секунду» (10), «XML XPath» (11), «JSONPath» (12), «В диапазоне» (13), «Соответствует регулярному выражению» (14), «Не соответствует регулярному выражению» (15), «Проверка наличия ошибки в JSON» (16), «Проверка наличия ошибки в XML» (17), «Проверка наличия ошибки с помощью регулярного выражения» (18), «Шаблон Prometheus» (22), «Преобразование Prometheus в JSON» (23), «Преобразование CSV в JSON» (24), «Проверка неподдерживаемого значения» (26), «Преобразование XML в JSON» (27), «Значение SNMP walk» (28), «Преобразование SNMP walk в JSON» (29) или «Значение SNMP get» (30) |
| error_handler_params | string | Параметры обработчика ошибок. Поведение свойства: - обязательное, если для error_handler установлено значение «Установить пользовательское значение» или «Установить пользовательское сообщение об ошибке» |
Для каждого типа предобработки поддерживаются следующие параметры и обработчики ошибок.
| Тип предобработки | Название | Параметр 1 | Параметр 2 | Параметр 3 | Поддерживаемые обработчики ошибок |
|---|---|---|---|---|---|
| 1 | Пользовательский множитель | число1, 6 | 0, 1, 2, 3 | ||
| 2 | Удаление символов справа | список символов2 | |||
| 3 | Удаление символов слева | список символов2 | |||
| 4 | Удаление символов с обеих сторон | список символов2 | |||
| 5 | Регулярное выражение | шаблон3 | вывод2 | 0, 1, 2, 3 | |
| 6 | Преобразование логического значения в десятичное | 0, 1, 2, 3 | |||
| 7 | Преобразование восьмеричного числа в десятичное | 0, 1, 2, 3 | |||
| 8 | Преобразование шестнадцатеричного числа в десятичное | 0, 1, 2, 3 | |||
| 9 | Простое изменение | 0, 1, 2, 3 | |||
| 10 | Изменение в секунду | 0, 1, 2, 3 | |||
| 11 | XML XPath | путь4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | путь4 | 0, 1, 2, 3 | ||
| 13 | В диапазоне | минимум1, 6 | максимум1, 6 | 0, 1, 2, 3 | |
| 14 | Соответствует регулярному выражению | шаблон3 | 0, 1, 2, 3 | ||
| 15 | Не соответствует регулярному выражению | шаблон3 | 0, 1, 2, 3 | ||
| 16 | Проверка наличия ошибки в JSON | путь4 | 0, 1, 2, 3 | ||
| 17 | Проверка наличия ошибки в XML | путь4 | 0, 1, 2, 3 | ||
| 18 | Проверка наличия ошибки с помощью регулярного выражения | шаблон3 | вывод2 | 0, 1, 2, 3 | |
| 19 | Отбрасывать неизменившиеся значения | ||||
| 20 | Отбрасывать неизменившиеся значения с контрольным интервалом | секунды5, 6 | |||
| 21 | JavaScript | скрипт2 | |||
| 22 | Шаблон Prometheus | шаблон6, 7 | value, label, function |
вывод8, 9 | 0, 1, 2, 3 |
| 23 | Преобразование Prometheus в JSON | шаблон6, 7 | 0, 1, 2, 3 | ||
| 24 | Преобразование CSV в JSON | символ2 | символ2 | 0,1 | 0, 1, 2, 3 |
| 25 | Замена | искомая строка2 | замена2 | ||
| 26 | Проверка неподдерживаемого значения | область1 | шаблон3, 6 | 1, 2, 3 | |
| 27 | Преобразование XML в JSON | 0, 1, 2, 3 | |||
| 28 | Значение SNMP walk | OID2 | Формат: 0 - Без изменений 1 - UTF-8 из Hex-STRING 2 - MAC из Hex-STRING 3 - Целое число из BITS |
0, 1, 2, 3 | |
| 29 | Преобразование SNMP walk в JSON10 | Имя поля2 | Префикс OID2 | Формат: 0 - Без изменений 1 - UTF-8 из Hex-STRING 2 - MAC из Hex-STRING 3 - Целое число из BITS |
0, 1, 2, 3 |
| 30 | Значение SNMP get | Формат: 1 - UTF-8 из Hex-STRING 2 - MAC из Hex-STRING 3 - Целое число из BITS |
0, 1, 2, 3 | ||
1 целое число или число с плавающей точкой
2 строка
3 регулярное выражение
4 JSONPath или XML XPath
5 положительное целое число (с поддержкой суффиксов времени, например 30s, 1m, 2h, 1d)
6 пользовательский макрос, макрос LLD
7 шаблон Prometheus, соответствующий синтаксису:
<metric name>{<label name>="<label value>", ...} == <value>. Каждый
компонент шаблона Prometheus (метрика, имя метки, значение метки и значение метрики)
может быть пользовательским макросом или макросом LLD.
8 вывод Prometheus, соответствующий синтаксису: <label name> (может быть пользовательским макросом или макросом LLD), если в качестве второго параметра выбран label.
9 Одна из функций агрегации: sum, min, max, avg, count, если в качестве второго параметра выбрана function.
10 Поддерживает несколько записей «Имя поля,Префикс OID,Формат», разделенных символом новой строки.