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

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

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

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

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

Свойство Type Описание
itemid ID ID элемента данных.

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

Принимает секунды или единицу времени с суффиксом (например, 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), или если 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 Имя элемента данных.
Поддерживает пользовательские макросы.

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

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

Возможные значения:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
9 - Веб-элемент данных;
10 - External check;
11 - Database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
15 - Calculated;
16 - JMX agent;
17 - SNMP trap;
18 - Зависимый элемент данных;
19 - HTTP agent;
20 - SNMP agent;
21 - Script;
22 - Browser.

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

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

По умолчанию: 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 agent.

Значение по умолчанию: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Поведение свойства:
- поддерживается, если type установлен в "JMX agent"
- только для чтения для обнаруженных объектов
lastclock timestamp Время последнего обновления значения элемента данных.

По умолчанию отображаются только значения за последние 24 часа. Вы можете увеличить этот период времени, изменив значение параметра Max history display period в разделе меню Администрирование → Общие.

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

По умолчанию отображаются только значения за последние 24 часа. Вы можете увеличить этот период времени, изменив значение параметра Max history display period в разделе меню Администрирование → Общие.

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

По умолчанию отображаются только значения за последние 24 часа. Вы можете увеличить этот период времени, изменив значение параметра Max history display period в разделе меню Администрирование → Общие.

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

По умолчанию отображаются только значения за последние 24 часа. Вы можете увеличить этот период времени, изменив значение параметра Max history display period в разделе меню Администрирование → Общие.

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

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

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

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

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

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

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

Поведение свойства:
- только для чтения
timeout string Тайм-аут запроса опроса данных элемента данных.
Принимает секунды или единицу времени с суффиксом (например, 30s, 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"
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 ID связанной карты значений.

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

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

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

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

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

HTTP-заголовок

Объект заголовка имеет следующие свойства:

Свойство Type Описание
name string Имя HTTP-заголовка.

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

Поведение свойства:
- обязательно

Поле HTTP-запроса

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

Свойство Тип Описание
name string Имя параметра.

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

Поведение свойства:
- обязательно

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

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

Свойство Type Описание
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), Check unsupported (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 Проверка неподдерживаемости область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 число с плавающей точкой (целые числа неявно преобразуются в значения float)
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,Формат", разделённых символом новой строки.