Объект элемента данных

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

Элемент данных

Веб-элементы данных нельзя напрямую создавать, изменять или удалять с помощью Zabbix API.

Объект элемента данных имеет следующие свойства.

Property Type Description
itemid ID Идентификатор элемента данных.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
delay string Интервал обновления элемента данных.

Принимает количество секунд (например, 1, 60, 300), значение с суффиксом времени (например, 30s, 1m, 2h, 1d) или, опционально, один или несколько пользовательских интервалов, разделённых точками с запятой. Пользовательские интервалы могут представлять собой сочетание гибких интервалов и интервалов расписания.

Поддерживает пользовательские макросы. При использовании макроса значение должно состоять из одного макроса. Несколько макросов или макросы, смешанные с текстом, не поддерживаются. Гибкие интервалы можно записывать как два макроса, разделённых косой чертой (например, {$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), "Telemetry query" (24) или если type имеет значение "Zabbix agent (active)" (7), а key_ не содержит "mqtt.get"
hostid ID Идентификатор узла сети или шаблона, которому принадлежит элемент данных.

Поведение свойства:
- константа
- обязательно для операций создания
interfaceid 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 Имя элемента данных.
Поддерживает пользовательские макросы.

Поведение свойства:
- обязательно для операций создания
- только для чтения для унаследованных или обнаруженных объектов
name_resolved string Имя элемента данных с раскрытыми пользовательскими макросами.

Поведение свойства:
- только для чтения
type integer Тип элемента данных.

Возможные значения:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
9 - Web item;
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;
24 - Telemetry query.

Поведение свойства:
- обязательно для операций создания
- только для чтения для унаследованных или обнаруженных объектов
url string Строка URL.
Поддерживает пользовательские макросы, {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 Описание элемента данных.

Поведение свойства:
- только для чтения для обнаруженных объектов
error string Текст ошибки, если возникли проблемы при обновлении значения элемента данных.

Поведение свойства:
- только для чтения
flags integer Источник элемента данных.

Возможные значения:
0 - обычный элемент данных;
4 - элемент данных, преобразованный из прототипа.

Поведение свойства:
- только для чтения
follow_redirects integer Следовать перенаправлениям ответа при опросе данных.

Возможные значения:
0 - не следовать перенаправлениям;
1 - (по умолчанию) следовать перенаправлениям.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных или обнаруженных объектов
headers array Массив заголовков, отправляемых при выполнении HTTP-запроса.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных или обнаруженных объектов
history string Единица времени, определяющая, как долго должны храниться данные истории.
Также поддерживает пользовательский макрос.

По умолчанию: 31d.

Поведение свойства:
- только для чтения для обнаруженных объектов
http_proxy string Строка подключения к прокси HTTP(S).

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных или обнаруженных объектов
inventory_link integer Идентификатор поля инвентаризации узла сети, заполняемого элементом данных.

Список поддерживаемых полей инвентаризации узла сети и их идентификаторов приведён на странице инвентаризации узла сети.

По умолчанию: 0.

Поведение свойства:
- поддерживается, если value_type имеет значение "numeric float", "character", "numeric unsigned" или "text"
- только для чтения для обнаруженных объектов
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"
- только для чтения для обнаруженных объектов
lastclock timestamp Время последнего обновления значения элемента данных.

По умолчанию отображаются только значения за последние 24 часа. Этот период можно увеличить, изменив значение параметра Максимальный период отображения истории в разделе меню Администрирование > Общие.

Поведение свойства:
- только для чтения
lastns integer Наносекунды последнего обновления значения элемента данных.

По умолчанию отображаются только значения за последние 24 часа. Этот период можно увеличить, изменив значение параметра Максимальный период отображения истории в разделе меню Администрирование > Общие.

Поведение свойства:
- только для чтения
lastvalue string Последнее значение элемента данных.

По умолчанию отображаются только значения за последние 24 часа. Этот период можно увеличить, изменив значение параметра Максимальный период отображения истории в разделе меню Администрирование > Общие.

Поведение свойства:
- только для чтения
logtimefmt string Формат времени в записях журнала.

Поведение свойства:
- поддерживается, если value_type имеет значение "log"
- только для чтения для унаследованных или обнаруженных объектов
master_itemid 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"
- только для чтения для унаследованных или обнаруженных объектов
prevvalue string Предыдущее значение элемента данных.

По умолчанию отображаются только значения за последние 24 часа. Этот период можно увеличить, изменив значение параметра Максимальный период отображения истории в разделе меню Администрирование > Общие.

Поведение свойства:
- только для чтения
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"
- только для чтения для унаследованных или обнаруженных объектов
state integer Состояние элемента данных.

Возможные значения:
0 - (по умолчанию) нормальное;
1 - не поддерживается.

Поведение свойства:
- только для чтения
status integer Состояние элемента данных.

Возможные значения:
0 - (по умолчанию) элемент данных включён;
1 - элемент данных отключён.
status_codes string Диапазоны требуемых кодов состояния HTTP, разделённые запятыми.
Также поддерживает пользовательские макросы как часть списка, разделённого запятыми.

Пример: 200,200-{$M},{$M},200-400

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных или обнаруженных объектов
templateid ID Идентификатор родительского элемента данных шаблона.

Подсказка: Используйте свойство hostid, чтобы указать шаблон, которому принадлежит элемент данных.

Поведение свойства:
- только для чтения
timeout string Тайм-аут запроса на опрос данных элемента данных.
Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 300s, 1m). Также поддерживает пользовательские макросы.

Допустимый диапазон значений: 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".
Если свойство не указано, ему автоматически присваивается пользовательский макрос {$TRAPPER.ALLOWED_HOSTS} (значение по умолчанию). По умолчанию {$TRAPPER.ALLOWED_HOSTS} имеет значение 127.0.0.1,::1.
Если свойству присвоена пустая строка, входящие подключения от всех узлов сети будут запрещены.
trends string Единица времени, определяющая, как долго должны храниться данные трендов.
Также поддерживает пользовательский макрос.

По умолчанию: 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 Идентификатор связанной карты значений.

Поведение свойства:
- поддерживается, если value_type имеет значение "numeric float", "character" или "numeric unsigned"
- только для чтения для унаследованных или обнаруженных объектов
verify_host integer Следует ли проверять соответствие имени узла сети для подключения имени, указанному в сертификате узла сети.

Возможные значения:
0 - (по умолчанию) не проверять;
1 - проверять.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных или обнаруженных объектов
verify_peer integer Следует ли проверять подлинность сертификата узла сети.

Возможные значения:
0 - (по умолчанию) не проверять;
1 - проверять.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных или обнаруженных объектов
query object Конфигурация запроса телеметрии. Определяет, какие данные элемент данных запрашивает из источника телеметрии, как фильтрует данные и как агрегирует результат.

Поведение свойства:
- обязательно, если type имеет значение "Telemetry query"
- только для чтения для унаследованных или обнаруженных объектов
time_shift string Насколько далеко в прошлое (до текущего времени) заканчивается временной диапазон, запрашиваемый элементом данных.

Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 2h, 1d). Также поддерживает пользовательские макросы.

Допустимый диапазон значений: 0-86400s.

По умолчанию: 15s.

Поведение свойства:
- поддерживается, если type имеет значение "Telemetry query"
lookback_limit string Насколько далеко в прошлое (до текущего времени) элемент данных запрашивает данные, если отсутствует предыдущий запрос, который можно продолжить (например, при первом запуске элемента данных), или если предыдущий запрос старше delay (например, из-за недоступности сервера Zabbix).

Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 2h, 1d). Также поддерживает пользовательские макросы.

Допустимый диапазон значений: 1-259200s.

По умолчанию: 10m.

Поведение свойства:
- поддерживается, если type имеет значение "Telemetry query"
granularity string Длительность фрагмента, на который разбивается полный временной диапазон запроса.

Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 2h, 1d). Также поддерживает пользовательские макросы.

Допустимый диапазон значений: 1-86400s.

По умолчанию: 15s.

Поведение свойства:
- поддерживается, если type имеет значение "Telemetry query"

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
signal_type integer Тип сигнала, который запрашивает элемент данных.

Возможные значения:
0 - Трассировки;
1 - Метрики;
2 - Журналы.

Поведение свойства:
- обязательное
metric_point_type integer Тип точки метрики, который запрашивает элемент данных.

Возможные значения:
0 - Сумма;
1 - Показатель;
2 - Гистограмма;
3 - Экспоненциальная гистограмма.

Поведение свойства:
- обязательное, если для signal_type установлено значение "Metrics"
columns array Массив столбцов данных телеметрии, которые запрашивает элемент данных. Может быть пустым.

Поведение свойства:
- обязательное
aggregated_columns array Массив агрегированных столбцов данных телеметрии, которые запрашивает элемент данных, а также способ вычисления значения на основе записей столбцов.

Поведение свойства:
- обязательное
filter object Фильтр запроса телеметрии для записей столбцов в запросе.

Поведение свойства:
- обязательное
Столбцы данных телеметрии

Объект столбцов данных телеметрии имеет следующие свойства.

Property Type Description
column string Имя столбца данных телеметрии, который запрашивает элемент данных.
См. поддерживаемые столбцы данных телеметрии.

Для нескольких столбцов с одиночными значениями каждое значение column должно быть уникальным. Для нескольких столбцов, содержащих пары «ключ-значение», каждая пара column и attribute_key должна быть уникальной.
attribute_key string Имя ключа, который запрашивает элемент данных, в столбце, содержащем пары «ключ-значение».

Для нескольких столбцов, содержащих пары «ключ-значение», каждая пара column и attribute_key должна быть уникальной.

Поведение свойства:
- обязательно, если column задано как столбец, содержащий пары «ключ-значение»
Агрегированные столбцы данных телеметрии

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

Property Type Description
column string Имя столбца данных телеметрии, который запрашивает элемент данных.
См. поддерживаемые столбцы данных телеметрии.

Для нескольких столбцов каждое значение column должно быть уникальным.

Это свойство не поддерживается, если для function установлено значение "Count".

Поведение свойства:
- обязательно, если для function установлено значение "Min", "Max", "Average", "Sum" или "Percentile"
function integer Функция, применяемая элементом данных к записям столбца.

Возможные значения:
1 - Min;
2 - Max;
3 - Average;
4 - Count;
5 - Sum;
8 - Percentile.

Поведение свойства:
- обязательно
parameters array Процентиль, который элемент данных вычисляет по записям столбца.

Возможное значение: число от 0 до 100, заданное в виде строки.

Поведение свойства:
- обязательно, если для function установлено значение "Percentile"
alias string Уникальное имя вычисленного значения, используемое для его идентификации в значении элемента данных.

Каждое значение alias должно быть уникальным.

Поведение свойства:
- обязательно
Фильтр данных телеметрии

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

Property Type Description
conditions array Условия фильтра данных телеметрии, которым должна соответствовать запись в столбце данных телеметрии.

Поведение свойства:
- обязательное
evaltype integer Метод вычисления условий фильтра.

Возможные значения:
0 - And/Or;
1 - And;
2 - Or;
3 - Пользовательское выражение.

Поведение свойства:
- обязательное
eval_formula string Сгенерированное выражение, используемое для вычисления условий фильтра. Выражение содержит идентификаторы, ссылающиеся на определенные условия фильтра по их formulaid. Значение eval_formula равно значению formula для фильтров с пользовательским выражением.

Поведение свойства:
- только для чтения
formula string Определенное пользователем выражение, используемое для вычисления условий фильтров с пользовательским выражением. Выражение должно содержать идентификаторы, ссылающиеся на определенные условия фильтра по их formulaid. Идентификаторы, используемые в выражении, должны в точности соответствовать идентификаторам, определенным в условиях фильтра: ни одно условие не должно оставаться неиспользованным или быть пропущенным.

Поведение свойства:
- обязательное, если для evaltype установлено значение "Пользовательское выражение"
Условия фильтрации данных телеметрии

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

Property Type Description
column string Имя столбца данных телеметрии, к которому применяется условие фильтрации.
См. поддерживаемые столбцы данных телеметрии.

Поведение свойства:
- обязательное
attribute_key string Имя ключа, к которому применяется условие, в столбце, содержащем пары «ключ-значение».

Поведение свойства:
- обязательное, если column задан как столбец, содержащий пары «ключ-значение»
operator integer Оператор условия фильтрации.

Возможные значения для столбцов с одиночными значениями:
0 - Равно;
1 - Не равно;
2 - Содержит;
3 - Не содержит.

Возможные значения для столбцов, содержащих пары «ключ-значение»:
0 - Равно;
1 - Не равно;
12 - Существует.

Поведение свойства:
- обязательное
value string Значение для сравнения.

Поведение свойства:
- обязательное, если operator задан как "Равно", "Не равно", "Содержит" или "Не содержит"
formulaid string Произвольный уникальный идентификатор, используемый для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть задан пользователем при изменении условий фильтрации, но при последующем запросе будет сгенерирован заново.

Поведение свойства:
- обязательное, если evaltype объекта Фильтр запроса телеметрии задан как "Пользовательское выражение"

Тег элемента данных

Объект тега элемента данных имеет следующие свойства.

Property Type Description
tag string Имя тега элемента данных.

Поведение свойства:
- required
value string Значение тега элемента данных.

Поведение свойства:
- read-only.
object integer Тип объекта, от которого был унаследован тег.

Возможные значения:
0 - шаблон;
1 - узел сети.

Поведение свойства:
- read-only.
objectid ID ID объекта, от которого был унаследован тег.

Поведение свойства:
- read-only.

Предобработка элемента данных

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

Свойство Тип Описание
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 пользовательский макрос
7 шаблон Prometheus, соответствующий синтаксису: <metric name>{<label name>="<label value>", ...} == <value>. Каждый компонент шаблона Prometheus (метрика, имя метки, значение метки и значение метрики) может быть пользовательским макросом.
8 вывод Prometheus, соответствующий синтаксису: <label name> (может быть пользовательским макросом), если в качестве второго параметра выбран label.
9 Одна из функций агрегации: sum, min, max, avg, count, если в качестве второго параметра выбрано function.
10 Поддерживает несколько записей «Имя поля,Префикс OID,Формат», разделенных символом новой строки.