На странице
Объект прототипа элемента данных
Следующие объекты напрямую связаны с API itemprototype.
Прототип элемента данных
Объект прототипа элемента данных имеет следующие свойства.
| Свойство | Type | Описание |
|---|---|---|
| itemid | ID | ID прототипа элемента данных. Поведение свойства: - только для чтения - обязательно для операций обновления |
| delay | string | Интервал обновления прототипа элемента данных. Принимает секунды или единицу времени с суффиксом (например, 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 агент; 2 - Zabbix trapper; 3 - Простая проверка; 5 - Внутренний элемент Zabbix; 7 - Zabbix агент (активный); 10 - Внешняя проверка; 11 - Монитор базы данных; 12 - IPMI агент; 13 - SSH агент; 14 - TELNET агент; 15 - Вычисляемый; 16 - JMX агент; 17 - SNMP trap; 18 - Зависимый элемент данных; 19 - HTTP агент; 20 - SNMP агент; 21 - Скрипт; 22 - Браузер. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов |
| 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 - двоичный; 6 - JSON. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов |
| allow_traps | integer | Разрешить заполнять значение аналогично элементу данных trapper. 0 - (по умолчанию) Не разрешать прием входящих данных; 1 - Разрешить прием входящих данных. Поведение свойства: - поддерживается, если type задан как "HTTP agent" |
| authtype | integer | Метод аутентификации. Возможные значения, если type задан как "SSH agent":0 - (по умолчанию) пароль; 1 - открытый ключ. Возможные значения, если type задан как "HTTP agent":0 - (по умолчанию) нет; 1 - basic; 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 агент и TELNET агент; - SQL-запрос для прототипов элементов данных мониторинга базы данных; - формула для вычисляемых прототипов элементов данных; - скрипт для прототипов элементов данных скрипта и браузера. Поведение свойства: - обязательно, если 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 | SNMP OID. Поведение свойства: - обязательно, если 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 | Тайм-аут запроса опроса данных элемента данных. Принимает секунды или единицу времени с суффиксом (например, 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-заголовок
Объект заголовка имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| name | string | Имя HTTP-заголовка. Поведение свойства: - обязательно |
| value | string | Значение заголовка. Поведение свойства: - обязательно |
Поле HTTP-запроса
Объект поля запроса определяет имя и значение, используемые для указания параметра URL. Он имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| name | string | Имя параметра. Поведение свойства: - обязательно |
| value | string | Значение параметра. Поведение свойства: - обязательно |
Тег прототипа элемента данных
Объект тега прототипа элемента данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| tag | string | Имя тега прототипа элемента данных. Поведение свойства: - обязательно |
| value | string | Значение тега прототипа элемента данных. Поведение свойства: - только для чтения. |
| object | integer | Тип объекта, от которого был унаследован тег. Возможные значения: 0 - шаблон; 1 - узел сети. Поведение свойства: - только для чтения. |
| objectid | ID | ID объекта, от которого был унаследован тег. Поведение свойства: - только для чтения. |
Предобработка прототипа элемента данных
Объект предобработки прототипа элемента данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| 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 | В диапазоне | min1,\ 6 | max1,\ 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 | Проверка неподдерживаемости | scope1 | шаблон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,Формат", разделенных символом новой строки.