На странице
Объект элемента данных
Следующие объекты напрямую связаны с API item.
Элемент данных
Веб-элементы данных нельзя напрямую создавать, обновлять или удалять через Zabbix API.
Объект элемента данных имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| 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 - 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. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов или обнаруженных объектов |
| 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 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary. Поведение свойства: - обязательно для операций создания - только для чтения для унаследованных объектов или обнаруженных объектов |
| 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) proxy. Поведение свойства: - поддерживается если 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 в разделе меню Administration → General. Поведение свойства: - только для чтения |
| lastns | integer | Наносекунды, когда значение элемента данных было обновлено в последний раз. По умолчанию отображаются только значения, попадающие в последние 24 часа. Вы можете увеличить этот период, изменив значение параметра Max history display period в разделе меню Administration → General. Поведение свойства: - только для чтения |
| lastvalue | string | Последнее значение элемента данных. По умолчанию отображаются только значения, попадающие в последние 24 часа. Вы можете увеличить этот период, изменив значение параметра Max history display period в разделе меню Administration → General. Поведение свойства: - только для чтения |
| 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 - (по умолчанию) Raw data; 2 - JSON data; 3 - XML data. Поведение свойства: - поддерживается если 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 в разделе меню Administration → General. Поведение свойства: - только для чтения |
| 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. По умолчанию: "" - использовать настройки proxy/глобальные настройки. Поведение свойства: - поддерживается если 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 | Разрешенные узлы. Поведение свойства: - readonly для обнаруженных объектов - поддерживается если 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-заголовок
Объект заголовка имеет следующие свойства:
| 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 |
|---|---|---|
| tag | string | Имя тега элемента данных. Поведение свойства: - required |
| value | string | Значение тега элемента данных. |
Предобработка элемента данных
Объект предобработки элемента данных имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| 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 - Отбрасывать неизменившееся с heartbeat; 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. Property behavior: - required |
| params | string | Дополнительные параметры, используемые опцией предобработки. Несколько параметров разделяются символом новой строки (\n). Если type установлен в "Check unsupported", параметры используют синтаксис <scope>[\n<pattern>], где pattern - это регулярное выражение, а scope - одно из следующих значений:-1 - совпадение с любой ошибкой; \ 0 - проверить, совпадает ли сообщение об ошибке с pattern; \ 1 - проверить, не совпадает ли сообщение об ошибке с pattern. Property behavior: - required если type установлен в "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), Check unsupported (26), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30) |
| error_handler | integer | Тип действия, используемый в случае сбоя шага предобработки. Возможные значения: 0 - Сообщение об ошибке задается сервером Zabbix; 1 - Отбросить значение; 2 - Установить пользовательское значение; 3 - Установить пользовательское сообщение об ошибке. Возможные значения, если type установлен в "Check unsupported":1 - Отбросить значение; 2 - Установить пользовательское значение; 3 - Установить пользовательское сообщение об ошибке. Property behavior: - required если type установлен в "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30) |
| error_handler_params | string | Параметры обработчика ошибок. Property behavior: - required если error_handler установлен в "Set custom value" или "Set custom error message" |
Для каждого типа предобработки поддерживаются следующие параметры и обработчики ошибок.
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Custom multiplier | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Right trim | list of characters2 | |||
| 3 | Left trim | list of characters2 | |||
| 4 | Trim | list of characters2 | |||
| 5 | Regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Boolean to decimal | 0, 1, 2, 3 | |||
| 7 | Octal to decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal to decimal | 0, 1, 2, 3 | |||
| 9 | Simple change | 0, 1, 2, 3 | |||
| 10 | Change per second | 0, 1, 2, 3 | |||
| 11 | XML XPath | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | In range | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Matches regular expression | pattern3 | 0, 1, 2, 3 | ||
| 15 | Does not match regular expression | pattern3 | 0, 1, 2, 3 | ||
| 16 | Check for error in JSON | path4 | 0, 1, 2, 3 | ||
| 17 | Check for error in XML | path4 | 0, 1, 2, 3 | ||
| 18 | Check for error using regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Discard unchanged | ||||
| 20 | Discard unchanged with heartbeat | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Prometheus pattern | pattern6, 7 | value, label, function |
output8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus to JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV to JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Replace | search string2 | replacement2 | ||
| 26 | Check unsupported | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML to JSON | 0, 1, 2, 3 | |||
| 28 | SNMP walk value | OID2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk to JSON10 | Field name2 | OID prefix2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 |
| 30 | SNMP get value | Format: 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from 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 поддерживает несколько записей "Field name,OID prefix,Format records", разделенных символом новой строки.