Zabbix Documentation 4.4

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools

This translation is older than the original page and might be outdated. See what has changed.

Sidebar

ru:manual:api:reference:item:object

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

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

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

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

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

Свойство Тип Описание
itemid строка (только чтение) ID элемента данных.
delay
(требуется)
строка Интервал обновления элемента данных. Принимает секунды или единицы времени с суффиксом (30s,1m,2h,1d).
Опционально можно указывать один и более пользовательских интервалов, таких как как гибкие интервалы и интервалы по расписанию.
Несколько интервалов разделяются точкой с запятой.
Можно использовать пользовательские макросы. Один макрос должен заполнять значение целиком. Запись нескольких макросов в значении или смешение макросов с текстом не поддерживается.
Гибкие интервалы можно записать в виде двух макросов, разделенных прямой косой чертой(например, ​{$FLEX_INTERVAL}/​{$FLEX_PERIOD}​).

Опционально для Zabbix траппер и зависимых элементов данных.
hostid
(требуется)
строка ID узла сети или шаблона, которому принадлежит элемент данных.

При операциях обновления это поле только для чтения.
interfaceid
(требуется)
строка ID интерфейса узла сети элемента данных.

Не требуется для элементов данных из шаблона. Опционален для внутренних, активного агента, траппер, агрегированных, вычисляемых, зависимых и монитора баз данных элементов данных.
key_
(требуется)
строка Ключ элемента данных.
name
(требуется)
строка Имя элемента данных.
type
(требуется)
целое число Тип элемента данных.

Возможные значения:
0 - Zabbix агент;
1 - SNMPv1 агент;
2 - Zabbix траппер;
3 - простая проверка;
4 - SNMPv2 агент;
5 - Zabbix внутренний;
6 - SNMPv3 агент;
7 - Zabbix агент (активный);
8 - Zabbix агрегированный;
9 - веб элемент данных;
10 - внешняя проверка;
11 - монитор баз данных;
12 - IPMI агент;
13 - SSH агент;
14 - TELNET агент;
15 - вычисляемый;
16 - JMX агент;
17 - SNMP трап;
18 - Зависимый элемент данных;
19 - HTTP агент;
url
(требуется)
строка Строка URL, требуется для элемента данных типа HTTP агент. Поддерживаются пользовательские макросы, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.
value_type
(требуется)
целое число Тип информации элемента данных.

Возможные значения:
0 - числовое с плавающей точкой;
1 - символ;
2 - журнал (лог);
3 - числовое целое положительное;
4 - текст.
allow_traps целое число Поле HTTP агента элемента данных. Позволяет заполнять значение также как и в элементе данных с типом траппер.

0 - (по умолчанию) Не разрешать принимать входящие данные.
1 - Разрешать принимать входящие данные.
authtype целое число Используется только SSH агент и HTTP агент элементами данных.

Возможные значения метода аутентификации SSH агента:
0 - (по умолчанию) пароль;
1 - публичный ключ.

Возможные значения метода аутентификации HTTP агента:
0 - (по умолчанию) нет
1 - простая
2 - NTLM
3 - Kerberos
description строка Описание элемента данных.
error строка (только чтение) Текст ошибки, если имеются проблемы с обновлением элемента данных.
flags целое число (только чтение) Происхождение элемента данных.

Возможные значения:
0 - обычный элемент данных;
4 - обнаруженный элемент данных.
follow_redirects целое число Поле HTTP агента элемента данных. Следование перенаправлениям при опросе данных.

0 - Не следовать перенаправлениям.
1 - (по умолчанию) Следовать перенаправлениям.
headers объект Поле HTTP агента элемента данных. Объект с HTTP(S) заголовками запроса, где имя заголовка используется ключом, а значение заголовка используется значением.

Пример:
{ “User-Agent”: “Zabbix” }
history целое число Количество времени хранения данных истории элемента данных. Также принимает пользовательские макросы.

По умолчанию: 90d.
http_proxy строка Поле HTTP агента элемента данных. Строка подключения HTTP(S) прокси.
inventory_link целое число ID поля инвентарных данных узла сети, которое заполняется элементом данных.

Обратитесь к странице данных инвентаризации узла сети для получения списка поддерживаемых полей инвентарных данных узла сети и их ID.

По умолчанию: 0.
ipmi_sensor строка Сенсор IPMI. Используется только элементами данных IPMI.
jmx_endpoint строка Строка пользовательского соединения с JMX агентом.

Значение по умолчанию:
service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi
lastclock timestamp (только чтение) Время, когда элемент данных был в последний раз обновлен.

Это свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD.
lastns целое число (только чтение) Наносекунды, когда элемент данных был в последний раз обновлен.

Это свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD.
lastvalue строка (только чтение) Последнее значение элемента данных.

Это свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD.
logtimefmt строка Формат времени в записях журнала. Используется только в элементах данных журналов.
master_itemid целое число ID основного элемента данных.
Разрешена рекурсия до 3 зависимых элементов данных и максимальное количество зависимых элементов данных допустимо до 29999.

Требуется для Зависимых элементов данных.
output_format целое число Поле HTTP агента элемента данных. Нужно ли конвертировать ответ в JSON.

0 - (по умолчанию) Записывать сырым.
1 - Конвертировать в JSON.
params строка Дополнительные параметры, которые зависят от типа элемента данных:
- выполняемый скрипт в случае элементов данных SSH и Telnet;
- SQL запрос в случае элементов данных монитора базы данных;
- формула в случае вычисляемых элементов данных.
password строка Пароль для аутентификации. Используется элементами данных простой проверки, SSH, Telnet, монитором баз данных, JMX и HTTP агентом.
Когда используется JMX типом, имя пользователя тоже должно быть задано вместе с паролем или оба свойства необходимо оставить пустыми.
port строка Наблюдаемый элементом данных порт. Используется только элементами данных SNMP.
post_type целое число Поле HTTP агента элемента данных. Тип тела post данных записываемых в post свойстве.

0 - (по умолчанию) Сырые данные.
2 - JSON данные.
3 - XML данные.
posts строка Поле HTTP агента элемента данных. Данные тела запроса HTTP(S). Используется совместно с post_type.
prevvalue строка (только чтение) Предыдущее значение элемента данных.

то свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD.
privatekey строка Имя файла приватного ключа.
publickey строка Имя файла публичного ключа.
query_fields массив Поле HTTP агента элемента данных. Параметры запроса. Массив объектов с парами 'ключ':'значение', где значение может быть пустой строкой.
request_method целое число Поле HTTP агента элемента данных. Тип метода запроса.

0 - (по умолчанию) GET
1 - (по умолчанию) POST
2 - PUT
3 - HEAD
retrieve_mode целое число Поле HTTP агента элемента данных. Какую часть ответа нужно сохранять.

0 - (по умолчанию) Тело.
1 - Заголовки.
2 - Сохранять как тело, так и заголовки.

Для request_method HEAD разрешенное значение только 1.
snmp_community строка SNMP community. Используется только элементами данных SNMPv1 и SNMPv2.
snmp_oid строка SNMP OID.
snmpv3_authpassphrase строка Фраза-пароль аутентификации SNMPv3. Используется только элементами данных SNMPv3.
snmpv3_authprotocol целое число Протокол аутентификации SNMPv3. Используется только элементами данных SNMPv3.

Возможные значения:
0 - (по умолчанию) MD5;
1 - SHA.
snmpv3_contextname строка Имя контекста SNMPv3. Используется только элементами данных SNMPv3.
snmpv3_privpassphrase строка Фраза-пароль безопасности SNMPv3. Используется только элементами данных SNMPv3.
snmpv3_privprotocol целое число Протокол безопасности SNMPv3. Используется только элементами данных SNMPv3.

Возможные значения:
0 - (по умолчанию) DES;
1 - AES.
snmpv3_securitylevel целое число Уровень безопасности SNMPv3. Используется только элементами данных SNMPv3.

Возможные значения:
0 - noAuthNoPriv;
1 - authNoPriv;
2 - authPriv.
snmpv3_securityname строка Имя безопасности SNMPv3. Используется только элементами данных SNMPv3.
ssl_cert_file строка Поле HTTP агента элемента данных. Путь к файлу публичного SSL ключа.
ssl_key_file строка Поле HTTP агента элемента данных. Путь к файлу приватного SSL ключа.
ssl_key_password строка Поле HTTP агента элемента данных. Пароль к файлу SSL ключа.
state целое число (только чтение) Статус элемента данных.

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

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

Пример: 200,200-{$M},{$M},200-400
templateid строка (только чтение) ID родительского элемента данных из шаблона.

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

по умолчанию: 3s
максимальное значение: 60s
trapper_hosts строка Разрешенные хосты. Используется траппер и HTTP агент элементами данных.
trends целое число Количество времени хранения данных динамики изменений элемента данных. Также принимает пользовательские макросы.

По умолчанию: 365d.
units строка Единицы измерения значений.
username строка Имя пользователя для аутентификации. Используется элементами данных простой проверкой, SSH, Telnet, монитором баз данных, JMX и HTTP агентом.

Требуется для SSH и Telnet элементов данных.
Когда используется JMX типом, имя пользователя тоже должно быть задано вместе с паролем или оба свойства необходимо оставить пустыми.
valuemapid строка ID связанного преобразования значений.
verify_host целое число Поле HTTP агента элемента данных. Проверка имени узла в URL в полях Common Name или Subject Alternate Name сертификата хоста.

0 - (по умолчанию) Не проверять.
1 - Проверять.
verify_peer целое число Поле HTTP агента элемента данных. Проверка подлинности сертификата хоста.

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

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

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

Свойство Тип Описание
type
(требуется)
целое число Тип опции предобработки.

Возможные значения:
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.
params
(требуется)
строка Дополнительные параметры, которые используются опцией предобработки. несколько параметров разделяются символом LF (\n).
error_handler
(требуется)
целое число Тип действия, которое используется в случае ошибки на шаге предобработки.

Возможные значения:
0 - Сообщение об ошибке, которое задается Zabbix сервером;
1 - Отбрасывать значение;
2 - Задать пользовательское значение;
3 - Задать пользовательское сообщение об ошибке.
error_handler_params
(требуется)
строка Параметры обработчика ошибок. Используется совместно с error_handler.

Должно быть пустым, если error_handler равно значениям 0 или 1.
Может быть пустым, если error_handler равно значению 2.
Не может быть пустым, если error_handler равно значению 3.

Следующие параметры и обработчики ошибок поддерживаются каждым типом предобработки.

Тип предобработки Имя Параметр 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 вывод6, 8 0, 1, 2, 3
23 Prometheus в JSON шаблон6, 7 0, 1, 2, 3
24 CSV в JSON символ2 символ2 0,1 0, 1, 2, 3

1 целое число или дробное число
2 строка
3 регулярное выражение
4 JSONPath или XML XPath
5 положительное целое число (с поддержкой суффиксов времени, например, 30s, 1m, 2h, 1d)
6 пользовательский макрос
7 шаблон Prometheus в следующем синтаксисе: <имя метрики>{<имя метки>=“<значение метки>”, …} == <значение>. Каждый компонент шаблона Prometheus (метрика, имя метки, значение метки и значение метрики) может быть пользовательским макросом.
8 вывод Prometheus в следующем синтаксисе: <имя метки>.