Documentation
Table of Contents
Објекат ставке
Следећи објекти су директно повезани са API-јем за item.
Ставка
Web ставке не могу бити директно креиране, ажуриране или обрисане преко 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}[Понашање |
| својства](/manual/api/reference_commentary#property-behavior): - обавезно ако је 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) and 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", or "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}, {ITEM.ID} , {ITEM.KEY}. Понашање својства: - обавезно ако је type подешен на "HTTP agent"<br >- само за читање за наслеђене објекте или откривене објекте |
| value_type | integer | TТип информације ставке. Могуће вредности: 0 - нумерички float; 1 - карактер; 2 - лог; 3 - нумерички неозначен; 4 - текст; 5 - бинарни. Понашање својства: - обавезно за операције креирања - само за читање за наслеђене објекте или откривене објекте |
| allow_traps | integer | Да ли дозвољава попуњавање вредности као за trapper ставке. 0 - (подразумевано) Не дозволи прихватање долазних података; 1 - Дозволи прихватање долазних података. Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за откривене објекте |
| authtype | integer | Метод аутентификације. Могуће вредности ако је type подешен на "SSH agent":0 - лозинка (подразумевана); 1 - јавни кључ.<br > Могуће вредности ако је type подешен на "HTTP agent":0 - (подразумевано) ништа; 1 - basic; 2 - NTLM; 3 - Kerberos . Понашање својства: - подржано ако је 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 | Низ од headers који ће бити послат приликом извршавања 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 агент прилагођени низ конекције. Подразумевана вредност: service:jmx:rmi:///jndi/rmi ://{HOST.CONN}:{HOST.PORT}/jmxrmi Понашање својства: - подржано ако је type постављено на "JMX agent"- само за читање за откривене објекте |
| lastclock | timestamp | Време последњег ажурирања вредности ставке. Подразумевано, приказују се само вредности које се не извршавају у последња 24 сата. Можете проширити овај период изменом параметра Максималан перод визуализације историје у одељку Administration → General. Понашање својства: - само за читање |
| lastns | integer | Наносекунде у којима је вредност ставке последњи пут ажурирана. Подразумевано, приказују се само вредности које се не извршавају у последња 24 сата. Можете проширити овај период изменом параметра Максималан перод визуализације историје у одељку Administration → General. Понашање својства: - само за читање |
| lastvalue | string | Последња вредност ставке. Подразумевано, приказују се само вредности које се не извршавају у последња 24 сата. Можете проширити овај период изменом параметра Максималан перод визуализације историје у одељку Administration → General. Понашање својства: - само за читање |
| logtimefmt | string | Формат времена у лог уносима [Понашање својства] (/manual/api/reference_commentary#property-behavior): - подржано ако је value_type подешен на "log"- само за читање за наследне објекте или откривене објекте |
| master_itemid | ID | ID главне ставке. Рекурзија до 3 зависне ставке и максимални број зависних ставки је дозвољен до 29999. Понашање својства: - обавезно ако је type подешен на "Зависна метрика"- само за читање за наследне објекте или откривене објекте |
| output_format | integer | Треба ли одговор да се конвертује у JSON.. 0 - (подразумевано) Чување необрађених података; 1 - Конверзија у JSON. Понашање својства: - подржано ако је type подешен на "HTTP агент"- само за читање за наследне објекте или откривене објекте |
| params | string | Додатни параметри у зависности од типа ставке:< br>- извршени скрипт за ставке SSH агент и TELNET агент; - SQL упит за ставке праћења базе података; - формула за израчунате ставке; - скрипт за скриптоване и 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 | Лозинка за аутентификацију. Понашање својства:<br >- обавезно ако је type подешен на "JMX agent" и username је подешен- подржано ако је type подешен на "Simple check", "SSH agent", "TELNET agent", "Database monitor", или "HTTP agent"- само за читање за наследне објекте (ако је type подешен на "HTTP agent") или откривене објекте |
| post_type | integer | Тип података објаве који се чува у својству posts.Могуће вредности: 0 - (подразумевано) Сирови подаци; 2 - JSON подаци; 3 - XML подаци. Понашање својства: - подржано ако је type постављен на "HTTP агент"- само за читање за наслеђене или откривене објекте |
| posts | string | Подаци тела HTTP(S) захтева. Понашање својства: - обавезно ако је type постављен на "HTTP агент" и post_type на "JSON подаци" или "XML подаци"- обавезно ако је type поствљен на "HTTP agent" и post_type је постављено на "Сирови подаци"- само за читање за наслеђене или откривене објекте |
| prevvalue | string | Претходна вредност ставке. Подразумевано, приказују се само вредности које нису извршене у последња 24 сата. Овај период можете проширити променом параметра Максималан период приказа историје у менију Administration → General. Понашање својства: - само за читање |
| privatekey | string | Назив датотеке приватног кључа. Понашање својства: - обавезно ако је type подешен на "SSH agent" и authtype је подешен на "јавни кључ"- само за читање за откривене објекте |
| publickey | string | Назив датотеке јавног кључа. Понашање својства: - обавезно ако је type постављен на "SSH agent" и authtype на "јавни кључ"- само за читање за откривене објекте |
| query_fields | array | Низ поља упита која ће се слати приликом извршавања HTTP захтева. Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за наслеђене или откривене објекте |
| request_method | integer | Тип методе захтева. Могуће вредности: 0 - (подразумевано) GET; 1 - POST; 2 - PUT; 3 - HEAD. Понашање својства: - подржано ако је type постављен на "HTTP agent"- само за читање за наслеђене или откривене објекте |
| retrieve_mode | integer | Део одговора који треба сачувати. <br >Могуће вредности ако је request_method постављен на "GET", "POST", или "PUT":0 - (подразумевано) Тело; 1 - Заглавља; 2 - Тело и заглавља ће бити сачувана. Могуће вредности ако је request_method постављен на "HEAD":1 - Заглавља. Понашање својства: - подржано ако је type постављен на "HTTP agent"- само за читање за наслеђене или откривене објекте |
| snmp_oid | string | SNMP OID.<br > Понашање својства: - обавезно ако је type постављен на "SNMP 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 агент"- само за читање за наслеђене или откривене објекте |
| templateid | ID | ID родитељске шаблонске ставке.<br > Савет: Користите својство hostid да наведете шаблон којем ставка припада.Понашање својства: - само за читање |
| timeout | string | Временски период за захтев за податке ставке. Прихвата секунде или временску јединицу са наставком (нпр. 30s, 1m). Прихвата и корисничке макрое. Опсег могућих вредности: 1-600 s. Подразумевано: "" - користите прокси/глобална подешавања. Понашање својства: - подржано ако је 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 | Дозвољени домаћини. Понашање својства:<br >- само за читање за откривене објекте - подржано ако је type подешен на "Zabbix trapper", или је type подешен на "HTTP agent" и allow_traps је подешен на "Дозвола за прихватање долазних података" |
| trends | string | Временска јединица која одређује колико дуго треба чувати податке трендова. Прихвата и кориснички макро. Подразумевано: 365d. Понашање својства: - подржано ако је value_type постављен на "numeric float" или "numeric unsigned"- само за читање за откривене објекте |
| units | string | Јединице вредности. Понашање својства: - подржано ако је value_type подешен на "numeric float", "character", или "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 агент"- само за читање за наслеђене или откривене објекте |
HTTP заглавље
Објекат заглавља има следећа својства: |Property|Type|Description| |--------|---------------------------------------------------|-----------| |name|string|Назив HTTP заглавља.
Понашање својства:
- обавезно|
|value|string|Вредност заглавља.
[Понашање својства] (/manual/api/reference_commentary#property-behavior):
- обавезно|
HTTP поље за упит
Објекат поља упита дефинише име и вредност који се користе за навођење URL параметра. Има следећа својства:
| Property | Type | Description |
|---|---|---|
| name | string | Назив параметра. Понашање својства: - обавезно |
| value | string | Вредност параметра. Понашање својства: - обавезно |
Ознака ставке
Објекат ознаке ставке има следећа својства.
| Property | Type | Description |
|---|---|---|
| tag | string | Назив ознаке ставке. Понашање својства: - обавезно |
| 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 - Одбаци непромењено са пулсом; 21 - JavaScript; 22 - Прометеус узорак; 23 - Прометеус у JSON; 24 - CSV у JSON; 25 - Замена; 26 - Провери неподржано; 27 - XML у JSON; 28 - SNMP преглед вредности; 29 - SNMP преглед у JSON формат; 30 - SNMP get претрага. Понашање својства: - обавезно |
| params | string | Додатни параметри које користи опција за обраду. Више параметара се одваја знаком нове линије (\n). Ако је type постављен на "Провери неподржано", параметри следе синтаксу <scope>[\n<pattern>], где је шаблон регуларни израз, а опсег је један од:-1 - подудара се са било којом грешком; 0 - проверава да ли порука о грешци одговара шаблону; 1 - проверава да ли порука о грешци не одговара шаблону. Понашање својства: - обавезно ако је type постављен на одређене типове као што су "Прилагођени множилац" (1), "Одсеци са десне стране" (2), "Одсеци са леве стране" (3), "Одсеци" (4), "Регуларни израз" (5), "XML XPath" (11), "JSONPath" (12), "У опсегу" (13), "Подудара се са регуларним изразом" (14), "Не подудара се са регуларним изразом" (15), "Провера грешке у JSON-у" (16), "Провера грешке у XML-у" (17), "Провера грешке користећи регуларни израз" (18), "Одбаци непромењено са пулсом" (20), "JavaScript" (21), " Прометеус узорак" (22), "Прометеус у JSON" (23), "CSV у JSON" (24), "Замена" (25), Провера неподржаног (26),"SNMP преглед вредности " (28), "SNMP преглед у 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), "Прометеус узаорак" (22), "Прометеус у JSON" (23), "CSV у JSON" (24), "Подржи неподржано" (26), "XML у JSON" (27), " SNMP преглед вредности" (28) o "SNMP преглед у JSON формат" (29), или "Вредност SNMP get" (30) |
| error_handler_params | string | Параметри за руковање грешкама. Понашање својства: - обавезно ако је error_handler постављен на "Постави прилагођену вредност" или "Постави прилагођену поруку о грешци" |
Подржани параметри и руковање грешкама за сваку врсту предобраде:
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Прилагођени множилац | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Одсеци са десне стране | list of characters2 | |||
| 3 | Одсеци са леве стране | list of characters2 | |||
| 4 | Одсеци | list of characters2 | |||
| 5 | Регуларни израз | pattern3 | output2 | 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 | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | У опсегу | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Подудара се са регуларним изразом | pattern3 | 0, 1, 2, 3 | ||
| 15 | Не подудара се са регуларним изразом | pattern3 | 0, 1, 2, 3 | ||
| 16 | Провера грешке у JSON-у | path4 | 0, 1, 2, 3 | ||
| 17 | Провера грешке у XML-у | path4 | 0, 1, 2, 3 | ||
| 18 | Провера грешке користећи регуларним изразом | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Одбаци непромењено | ||||
| 20 | Одбаци непромењено са пулсом | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Прометеус образац | pattern6, 7 | value, label, function |
output8, 9 | 0, 1, 2, 3 |
| 23 | Прометеус у JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV у JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Замена | search string2 | replacement2 | ||
| 26 | Провери непотврђено | 1, 2, 3 | |||
| 27 | XML у JSON | 0, 1, 2, 3 | |||
| 28 | SNMP преглед вредности | 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 преглед 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 | Format: 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | ||
1 integer или број у покретном зарезу
2 string
3 регуларни израз
4 JSONPath или XML XPath
5 позитиван integer број (уз подршку за суфиксе времена, нпр. 30s, 1m, 2h, 1d)
6 кориснички макро
7 Прометеус узорак који прати следећу синтаксу: <metric name>{<label name>="<label value>", ...} == <value>. Сваки део Прометеус узорка (метрика, име ознаке, вредност ознаке и вредност метрике) може бити макро корисника.
8 Прометеус излаз који прати следећу синтаксу: <label name> (може бити кориснички макро) ако је label iизабрана као други параметар.
9 Једна од функција агрегације: sum, min, max, avg, count ако је function изабрана као други параметар..
10 Подржава више записа у формату "Име поља,OID префикс,Формат записа" раздвојених знаком нове линије.