Documentation
监控项对象
以下对象直接与item API 相关。
监控项
Web监控项不能直接通过Zabbix API创建、更新或删除。
监控项对象具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| 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}属性行为: - 如果 类型设置为"Zabbix agent"(0), "简单检查"(3), "Zabbix内部"(5), "外部检查"(10), "数据库监控"(11), "IPMI客户端"(12), "SSH 客户端"(13), "TELNET 客户端"(14), "计算"(15), "JMX agent代理程序"(16), "HTTP 代理"(19), "SNMP 代理"(20), "脚本"(21), "Browser"(22)，或者如果类型设置为"Zabbix agent(主动式)"(7)且key_不包含"mqtt.get"，则为必需项 |
| hostid | ID | 监控项所属的主机或模板的ID。 属性行为: - 常量 - 创建操作的必需项 |
| interfaceid | ID | 监控项的主机接口的ID。 属性行为: - 如果监控项属于主机并且 类型设置为"Zabbix agent", "IPMI客户端", "JMX agent代理程序", "SNMP trap", 或 "SNMP代理"，则为必需项- 如果监控项属于主机并且 类型设置为"简单检查", "外部检查", "SSH 客户端", "TELNET 客户端", 或 "HTTP代理"，则为支持项- 继承对象或发现对象的只读属性 |
| key_ | string | 监控项键。 属性行为: - 创建操作的必需项 - 继承对象或发现对象的只读属性 |
| name | string | 监控项名称。支持用户宏。 属性行为: - 创建操作的必需项 - 继承对象或发现对象的只读属性 |
| name_resolved | string | 解析用户宏后的监控项名称。 属性行为: - 只读 |
| type | integer | 监控项类型。 可能的值： 0 - Zabbix agent； 2 - Zabbix trapper； 3 - 简单检查； 5 - Zabbix内部； 7 - Zabbix agent(主动式)； 9 - Web监控项； 10 - 外部检查； 11 - 数据库监控； 12 - IPMI客户端； 13 - SSH 客户端； 14 - TELNET 客户端； 15 - 可计算的； 16 - JMX agent代理程序； 17 - SNMP trap； 18 - 依赖项； 19 - HTTP代理； 20 - SNMP代理； 21 - 脚本； 22 - Browser。 属性行为: - 创建操作的必需项 - 继承对象或发现对象的只读属性 |
| url | string | URL 字符串。支持用户宏，{HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}。 属性行为: - 如果 类型设置为"HTTP代理"，则为必需项- 继承对象或发现对象的只读属性 |
| value_url | integer | 监控项的信息类型。 可能的值： 0 - 浮点数； 1 - 字符； 2 - 日志； 3 - 数值（无正负）； 4 - 文本； 5 - 二进制。 属性行为: - 创建操作的必需项 - 继承对象或发现对象的只读属性 |
| allow_traps | integer | 允许像trapper监控项一样填充值。 0 - (默认) 不允许接受传入数据； 1 - 允许接受传入数据。 属性行为: - 如果 类型设置为"HTTP代理"，则为支持项- 继承对象或发现对象的只读属性 |
| authtype | integer | 认证方法。 如果 类型设置为"SSH 客户端"的可能值：0 - (默认) 密码； 1 - 公钥。 如果 类型设置为"HTTP代理"的可能值：0 - (默认) 无； 1 - 基础； 2 - NTLM； 3 - Kerberos。 属性行为: - 如果 类型设置为"SSH 客户端"或"HTTP代理"，则为支持项- 如果 类型设置为"HTTP代理"，继承对象的只读属性或发现对象 |
| description | string | 监控项的描述。 属性行为: - 发现对象的只读属性 |
| error | string | 更新监控项值时出现问题的错误文本。 属性行为: - 只读 |
| flags | integer | 监控项的来源。 可能的值： 0 - 普通项； 4 - 发现的监控项。 属性行为: - 只读 |
| follow_redirects | integer | 在轮询数据时是否跟随响应重定向。 可能的值： 0 - 不跟随重定向； 1 - (默认) 跟随重定向。 属性行为: - 如果 类型设置为"HTTP代理"，则为支持项- 继承对象或发现对象的只读属性 |
| headers | array | 执行HTTP请求时将发送的headers数组。 属性行为: - 如果 类型设置为"HTTP代理"，则为支持项- 继承对象或发现对象的只读属性 |
| history | string | 历史数据应该存储的时间单位。 也接受用户宏。 默认值：31d。 属性行为: - 发现对象的只读属性 |
| http_proxy | string | HTTP(S)代理连接字符串。 属性行为: - 如果 类型设置为"HTTP代理"，则为支持项- 继承对象或发现对象的只读属性 |
| inventory_link | integer | 由监控项填充的主机库存字段的ID。 有关支持的主机库存字段及其ID的列表，请参阅主机库存页面。 默认值：0。 属性行为: - 如果 value_type设置为"numeric float", "character", "numeric unsigned", 或 "text"，则为支持项- 发现对象的只读属性 |
| ipmi_sensor | string | IPMI传感器。 属性行为: - 如果 类型设置为"IPMI客户端"且key_未设置为"ipmi.get"，则为必需项- 如果 类型设置为"IPMI客户端"，则为支持项- 继承对象或发现对象的只读属性 |
| jmx_endpoint | string | JMX agent代理程序自定义连接字符串。 默认值：service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi 属性行为: - 如果 类型设置为"JMX agent代理程序"，则为支持项- 发现对象的只读属性 |
| lastclock | 时间戳 | 监控项值上次更新的时间。 默认情况下，仅显示最近24小时内的值。您可以通过更改最大历史显示期限参数的值来扩展此时间段，该参数位于管理 → 常规菜单部分。 属性行为: - 只读 |
| lastns | integer | 监控项值上次更新时的纳秒数。 默认情况下，仅显示最近24小时内的值。您可以通过更改最大历史显示期限参数的值来扩展此时间段，该参数位于管理 → 常规菜单部分。 属性行为: - 只读 |
| lastvalue | string | 监控项的最后一个值。 默认情况下，仅显示最近24小时内的值。您可以通过更改最大历史显示期限参数的值来扩展此时间段，该参数位于管理 → 常规菜单部分。 属性行为: - 只读 |
| logtimefmt | string | 日志条目中时间的格式。 属性行为: - 如果 value_type设置为"log"，则为支持项- 继承对象或发现对象的只读属性 |
| master_itemid | ID | 主监控项的ID。 允许递归到3个依赖项，并且依赖项的最大数量等于29999。 属性行为: - 如果 类型设置为"Dependent item"，则为必需项- 继承对象或发现对象的只读属性 |
| output_format | integer | 响应是否应转换为JSON。 0 - (默认) 存储原始数据； 1 - 转换为JSON。 属性行为: - 如果 类型设置为"HTTP代理"，则为支持项- 继承对象或发现对象的只读属性 |
| params | string | 根据监控项类型的附加参数： - 对于SSH 客户端和TELNET 客户端项，执行的脚本； - 对于数据库监控项，SQL查询； - 对于计算项，公式； - 对于脚本和浏览器项，脚本。 属性行为: - 如果 类型设置为"Database monitor", "SSH 客户端", "TELNET 客户端", "Calculated", "脚本", 或 "Browser"，则为必需项- 继承对象（如果 类型设置为"脚本" 或 "Browser"）或发现对象的只读属性 |
| parameters | object/array | 如果类型设置为"脚本"或"Browser"，则为附加参数。具有name和value属性的对象数组，其中name必须是唯一的。属性行为: - 如果 类型设置为"脚本"或"Browser"，则为支持项- 继承对象或发现对象的只读属性 |
| password | string | 认证密码。 属性行为: - 如果 类型设置为"JMX agent"且设置了username，则为必需项- 如果 类型设置为"Simple check", "SSH 客户端", "TELNET 客户端", "Database monitor", 或 "HTTP 代理"，则为支持项- 继承对象（如果 类型设置为"HTTP 代理"）或发现对象的只读属性 |
| post_type | integer | 存储在posts属性中的post数据正文类型。可能的值： 0 - (默认) 原始数据； 2 - JSON数据； 3 - XML数据。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| posts | string | HTTP(S)请求正文数据。 属性行为: - 如果 类型设置为"HTTP 代理"且post_类型设置为"JSON data"或"XML data"，则为必需项- 如果 类型设置为"HTTP 代理"且post_type设置为"Raw data"，则为支持项- 继承对象或发现对象的只读属性 |
| prevvalue | string | 监控项的上一个值。 默认情况下，仅显示最近24小时内的值。您可以通过更改最大历史显示期限参数的值来扩展此时间段，该参数位于管理 → 常规菜单部分。 属性行为: - 只读 |
| privatekey | string | 私钥文件的名称。 属性行为: - 如果 类型设置为"SSH 客户端"且authtype设置为"public key"，则为必需项- 发现对象的只读属性 |
| publickey | string | 公钥文件的名称。 属性行为: - 如果 类型设置为"SSH 客户端"且authtype设置为"public key"，则为必需项- 发现对象的只读属性 |
| query_fields | array | 执行HTTP请求时将发送的查询字段数组。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| request_method | integer | 请求方法的类型。 可能的值： 0 - (默认) GET； 1 - POST； 2 - PUT； 3 - HEAD。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| retrieve_mode | integer | 应存储响应的哪一部分。 如果 request_method设置为"GET", "POST", 或 "PUT"的可能值：0 - (默认) 正文； 1 - 标题； 2 - 存储正文和标题。 如果 request_method设置为"HEAD"的可能值：1 - 标题。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| snmp_oid | string | SNMP OID。 属性行为: - 如果 类型设置为"SNMP 代理"，则为必需项- 继承对象或发现对象的只读属性 |
| ssl_cert_file | string | 公共SSL密钥文件路径。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| ssl_key_file | string | 私有SSL密钥文件路径。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| ssl_key_password | string | SSL密钥文件的密码。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| state | integer | 监控项的状态。 可能的值： 0 - (默认) 正常； 1 - 不支持。 属性行为: - 只读 |
| status | integer | 监控项的状态。 可能的值： 0 - (默认) 启用的监控项； 1 - 禁用的监控项。 |
| status_codes | string | 所需的HTTP状态代码范围，由逗号分隔。 还支持用户宏作为逗号分隔列表的一部分。 示例：200,200-{$M},{$M},200-400 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| templateid | ID | 父模板监控项的ID。 提示：使用 hostid属性指定监控项所属的模板。属性行为: - 只读 |
| timeout | string | 监控项数据轮询请求的超时时间。 接受秒或带后缀的时间单位（例如，30s, 1m）。也接受用户宏。 可能的值范围：1-600s。 默认值："" - 使用代理/全局设置。 属性行为: - 如果 类型设置为"Zabbix agent" (0), "简单检查" (3) 且 key_ 不以 "vmware." 和 "icmpping" 开头，"Zabbix agent (active)" (7), "外部检查" (10), "数据库监控" (11), "SSH 客户端" (13), "TELNET 客户端" (14), "HTTP 代理" (19), "SNMP 代理" (20) 且 snmp_oid 以 "walk[" 或 "get[" 开头，"脚本" (21), "浏览器" (22)，则为支持项- 继承对象或发现对象的只读属性 |
| trapper_hosts | string | 允许的主机。 属性行为: - 发现对象的只读属性 - 如果 类型设置为"Zabbix trapper"，或如果类型设置为"HTTP 代理"且allow_traps设置为"允许接受传入数据"，则为支持项 |
| trends | string | 趋势数据应该存储的时间单位。 也接受用户宏。 默认值：365d。 属性行为: - 如果 value_类型设置为"numeric float"或"numeric unsigned"，则为支持项- 发现对象的只读属性 |
| units | string | 值的单位。 属性行为: - 如果 value_类型设置为"numeric float"或"numeric unsigned"，则为支持项- 继承对象或发现对象的只读属性 |
| username | string | 认证用户名。 属性行为: - 如果 类型设置为"SSH 客户端", "TELNET 客户端"，或如果类型设置为"JMX agent"且设置了password，则为必需项- 如果 类型设置为"简单检查", "数据库监控"，或 "HTTP 代理"，则为支持项- 继承对象（如果 类型设置为"HTTP 代理"）或发现对象的只读属性 |
| uuid | string | 通用唯一标识符，用于将导入的监控项与已有的关联。如果没有给出，则自动生成。 属性行为: - 如果监控项属于模板，则为支持项 |
| valuemapid | ID | 关联的值映射的ID。 属性行为: - 如果 value_type设置为"numeric float", "character"，或 "numeric unsigned"，则为支持项- 继承对象或发现对象的只读属性 |
| verify_host | integer | 是否验证连接的主机名是否与主机证书中的名称匹配。 可能的值： 0 - (默认) 不验证； 1 - 验证。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
| verify_peer | integer | 是否验证主机的证书是否真实。 可能的值： 0 - (默认) 不验证； 1 - 验证。 属性行为: - 如果 类型设置为"HTTP 代理"，则为支持项- 继承对象或发现对象的只读属性 |
HTTP头部
头部对象具有以下属性：
HTTP查询字段
查询字段对象定义了一个名称和值，用于指定URL参数。 它具有以下属性：
监控项标签
监控项标签对象具有以下属性。
监控项预处理
监控项预处理对象具有以下属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| type | integer | 预处理选项类型。 可用值： 1 - Custom multiplier（自定义乘数）； 2 - Right trim（移除右侧空白字符）； 3 - Left trim（移除左侧空白字符）； 4 - Trim（移除空白字符）； 5 - Regular expression matching（正则表达式匹配）； 6 - Boolean to decimal（布尔值转换十进制）； 7 - Octal to decimal（八进制转换十进制）； 8 - Hexadecimal to decimal（十六进制转十进制）； 9 - Simple change（先前值到新值的基本变化）； 10 - Change per second（每秒钟变化量）； 11 - XML XPath（XML 解析）； 12 - JSONPath（JSON解析）； 13 - In range（生成序列）； 14 - Matches regular expression（匹配正则表达式）； 15 - Does not match regular expression（不匹配正则表达式）； 16 - Check for error in JSON（检查 JSON 错误）； 17 - Check for error in XML（检查 XML 错误）； 18 - Check for error using regular expression（检查正则表达式使用错误）； 19 - Discard unchanged（丢弃重复数据）； 20 - Discard unchanged with heartbeat（设置心跳检查周期，丢弃重复数据）； 21 - JavaScript（JS格式）； 22 - Prometheus pattern（Prometheus 模式）； 23 - Prometheus to JSON（Prometheus 转换 JSON）； 24 - CSV to JSON（CSV 转换 JSON）； 25 - Replace（替换）； 26 - Check unsupported（检查不支持的值）； 27 - XML to JSON（XML 转换 JSON）; 28 - SNMP walk value（SNMP walk的值）; 29 - SNMP walk to JSON（SNMP walk转换JSON）; 30 - SNMP get value（SNMP获得的值）。 属性行为: - 必需项 |
| 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), "检查不支持"(26), "SNMP walk值"(28), "SNMP walk转JSON"(29), 或 "SNMP获取值"(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获取值"(30)，则为必需项 |
| error_handler_params | string | 错误处理程序参数。 属性行为: - 如果 error_handler设置为"设置自定义值"或"设置自定义错误消息"，则为必需项 |
预处理类型均支持以下参数和错误处理器。
| 预处理类型 | 名称 | 参数 1 | 参数 2 | 参数 3 | 支持的错误处理器 |
|---|---|---|---|---|---|
| 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（XML 解析） | path4（解析） | 0, 1, 2, 3 | ||
| 12 | JSONPath（JSON解析） | 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（检查 JSON 错误） | path4（解析） | 0, 1, 2, 3 | ||
| 17 | Check for error in XML（检查 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（JS格式） | script2 | |||
| 22 | Prometheus pattern（Prometheus 模式） | pattern6, 7（模式） | value, label, function |
output8, 9（输出） | 0, 1, 2, 3 |
| 23 | Prometheus to JSON（Prometheus 转换 JSON） | pattern6, 7（模式） | 0, 1, 2, 3 | ||
| 24 | CSV to JSON（CSV 转换 JSON） | character2（字符） | character2（字符） | 0,1 | 0, 1, 2, 3 |
| 25 | Replace（替换） | search string2（查找字符串） | replacement2（替换） | ||
| 26 | Check unsupported（检查不支持的值） | 1, 2, 3 | |||
| 27 | XML to JSON（XML 转换 JSON） | 0, 1, 2, 3 | |||
| 28 | SNMP walk value（SNMP walk 值） | OID2 | 格式: 0 - 无更改 1 - 从Hex-STRING转换为UTF-8 2 - 从Hex-STRING转换为MAC 3 - 从BITS转换为Integer |
0, 1, 2, 3 | |
| 29 | SNMP walk to JSON10（SNMP walk 转换 JSON） | 字段名称2 | OID 前缀2 | 格式: 0 - 无更改 1 - 从Hex-STRING转换为UTF-8 2 - 从Hex-STRING转换为MAC 3 - 从BITS转换为Integer 3 - Integer from BITS |
0, 1, 2, 3 |
| 30 | SNMP get value（SNMP获得值） | 格式: 1 - U从Hex-STRING转为UTF-8 2 - 从Hex-STRING转为MAC 3 - 从BITS转换为Intege |
0, 1, 2, 3 | ||
1 整数或浮点数 2 字符串 3 正则表达式 4JSONPath 或 XML XPath 5 正整数（支持时间后缀，例如：30s, 1m, 2h, 1d） 6用户宏 7Prometheus模式，遵循语法：<metric name>{<label name>="<label value>", ...} == <value>。每个Prometheus模式组件（指标、标签名称、标签值和指标值）都可以是用户宏。 8Prometheus输出，遵循语法：<label name>（可以是用户宏），如果标签被选作第二个参数。 9如果函数被选作第二个参数，则为聚合函数之一：sum（求和）、min（最小值）、max（最大值）、avg（平均值）、count（计数）。 10支持多个由换行符分隔的“字段名称，OID前缀，格式化记录”记录。