Documentation
Table of Contents
> Объект элемента данных
Следующие объекты напрямую связаны с item API.
Элементы данных
Веб элементы нельзя напрямую создавать, обновлять или удалять через Zabbix API.
Объект элемента данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| itemid | строка | (только чтение) ID элемента данных. |
| delay (требуется) |
строка | Интервал обновления элемента данных. Принимает секунды или единицы времени с суффиксом и с или без одного или нескольких пользовательских интервалов, которые состоят как из гибких интервалов, так и интервалов по расписанию в виде сериализованных строк. Также принимает пользовательские макросы. Гибкие интервалы можно записать в виде двух макросов, разделенных прямой косой чертой. Интервалы разделаются точкой с запятой. Опционально для элементов данных Zabbix траппер и Зависимых. |
| hostid (требуется) |
строка | ID узла сети или шаблона, которому принадлежит элемент данных. При операциях обновления это поле только для чтения. |
| interfaceid (требуется) |
строка | ID интерфейса узла сети элемента данных. Используется только элементами данных на узлах сети. Не требуется для элементов данных у шаблонов. Опционален для элементов данных Zabbix агента (активного), Zabbix внутреннего, Zabbix траппер, Зависимого элемента данных, Zabbix агрегированного, монитора баз данных и вычисляемого. |
| 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 - Зависимый элемент данных |
| value_type (требуется) |
целое число | Тип информации элемента данных. Возможные значения: 0 - числовое с плавающей точкой; 1 - символ; 2 - журнал (лог); 3 - числовое целое положительное; 4 - текст. |
| authtype | целое число | Метод аутентификации SSH. Используется только элементами данных SSH агента. Возможные значения: 0 - (по умолчанию) пароль; 1 - публичный ключ. |
| description | строка | Описание элемента данных. |
| error | строка | (только чтение) Текст ошибки, если имеются проблемы с обновлением элемента данных. |
| flags | целое число | (только чтение) Происхождение элемента данных. Возможные значения: 0 - обычный элемент данных; 4 - обнаруженный элемент данных. |
| history | целое число | Количество времени хранения данных истории элемента данных. Также принимает пользовательские макросы. По умолчанию: 90d. |
| inventory_link | целое число | ID поля инвентарных данных узла сети, которое заполняется элементом данных. Обратитесь к странице данных инвентаризации узла сети для получения списка поддерживаемых полей инвентарных данных узла сети и их ID. По умолчанию: 0. |
| ipmi_sensor | строка | Сенсор IPMI. Используется только элементами данных IPMI. |
| lastclock | timestamp | (только чтение) Время, когда элемент данных был в последний раз обновлен. Это свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD. |
| lastns | целое число | (только чтение) Наносекунды, когда элемент данных был в последний раз обновлен. Это свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD. |
| lastvalue | строка | (только чтение) Последнее значение элемента данных. Это свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD. |
| logtimefmt | строка | Формат времени в записях журнала. Используется только в элементах данных журналов. |
| mtime | timestamp | Время, когда наблюдаемый файл журнала был в последний раз обновлен. Используется только элементами данных журналов. |
| params | строка | Дополнительные параметры, которые зависят от типа элемента данных: - выполняемый скрипт в случае элементов данных SSH и Telnet; - SQL запрос в случае элементов данных монитора базы данных; - формула в случае вычисляемых элементов данных. |
| password | строка | Пароль для аутентификации. Используется элементами данных простой проверки, SSH, Telnet, монитором баз данных и JMX. |
| port | строка | Наблюдаемый элементом данных порт. Используется только элементами данных SNMP. |
| prevvalue | строка | (только чтение) Предыдущее значение элемента данных. то свойство вернёт значение только за период указанный в ZBX_HISTORY_PERIOD. |
| privatekey | строка | Имя файла приватного ключа. |
| publickey | строка | Имя файла публичного ключа. |
| 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. |
| state | целое число | (только чтение) Статус элемента данных. Возможные значения: 0 - (по умолчанию) нормальный; 1 - неподдерживается. |
| status | целое число | Состояние элемента данных. Возможные значения: 0 - (по умолчанию) активированный элемент данных; 1 - деактивированный элемент данных. |
| templateid | строка | (только чтение) ID родительского элемента данных из шаблона. Подсказка: Используйте свойство hostid, чтобы указать принадлежность элемента данных к шаблону. |
| trapper_hosts | строка | Разрешенные хосты. Используется только траппер элементами данных. |
| trends | целое число | Количество времени хранения данных динамики изменений элемента данных. Также принимает пользовательские макросы. По умолчанию: 365d. |
| units | строка | Единицы измерения значений. |
| username | строка | Имя пользователя для аутентификации. Используется элементами данных простой проверкой, SSH, Telnet, монитором баз данных и JMX. Требуется для элементов данных SSH и Telnet. |
| valuemapid | строка | ID связанного преобразования значений. |
| jmx_endpoint | строка | Строка пользовательского соединения с JMX агентом. Значение по умолчанию: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| master_itemid | целое число | ID основного элемента данных. Разрешена рекурсия до 3 зависимых элементов данных и максимальное количество зависимых элементов данных допустимо до 999. Требуется для Зависимых элементов данных. |
Предварительная обработка элементов данных
Объект предобработки элементов данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| type (требуется) |
целое число | Тип опции предварительной обработки. Возможные значения: 1 - Пользовательский множитель; 2 - Обрезка справа; 3 - Обрезка слева; 4 - Обрезка; 5 - Соответствие регулярному выражению; 6 - Двоичное в десятичное; 7 - Восьмеричное в десятичное; 8 - Шестнадцатеричное в десятичное; 9 - Простое изменение; 10 - Изменение в секунду. |
| params (требуется) |
строка | Дополнительные параметры используемые опцией предварительной обработки. Несколько параметров разделяются символом LF (\n). |