Documentation
监控项 object
以下 objects 直接与 item API 相关。
监控项
网页监控项无法直接通过Zabbix API进行创建、更新或删除。
该 监控项 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| itemid | ID | 监控项的ID。 属性行为: - 只读 - update操作中必填 |
| delay | string | 监控项的更新间隔。 接受秒数或带后缀的时间单位（例如30s、1m、2h、1d），并可选择性地包含一个或多个custom intervals，各项之间用分号分隔。自定义间隔可以是弹性间隔和调度间隔的混合。 接受用户宏。如果使用宏，其值必须为单个宏。不支持多个宏或宏与文本混合使用。弹性间隔可以写成由正斜杠分隔的两个宏（例如 {$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) - "简单检查" (3) - "Zabbix内部" (5) - "外部检查" (10) - "数据库监控" (11) - "IPMI agent" (12) - "SSH agent" (13) - "TELNET agent" (14) - "计算型" (15) - "JMX agent" (16) - "HTTP agent" (19) - "SNMP agent" (20) - "脚本" (21) - "浏览器" (22) - 或当 type设置为"Zabbix agent（主动）" (7)且key_不包含"mqtt.get"时 |
| hostid | ID | 主机或模板的ID，该监控项所属的实体。 属性行为: - 常量 - 对于create操作是必填项 |
| 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"时- 只读 对于发现的objects |
| key_ | string | 监控项 键 属性行为: - 为create操作必填 - 对继承的objects或发现的objects为只读 |
| name | string | 监控项的名称。 支持用户宏。 属性行为: - 对create操作为必填项 - 对继承的objects或发现的objects为只读 |
| name_resolved | string | 已解析用户宏的监控项名称。 属性行为: - 只读 |
| type | integer | 监控项的类型。 可能取值： 0 - Zabbix agent; 2 - Zabbix trapper; 3 - 简单检查; 5 - Zabbix内部; 7 - Zabbix agent（主动式）; 9 - Web 监控项; 10 - 外部检查; 11 - 数据库监控; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - 计算型; 16 - JMX agent; 17 - SNMP trap; 18 - 依赖型监控项; 19 - HTTP agent; 20 - SNMP agent; 21 - 脚本; 22 - 浏览器. 属性行为: - 必填 用于create操作 - 只读 用于继承的objects或发现的objects |
| url | string | URL string。 支持用户宏、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}。 属性行为: - 当 type设置为"HTTP agent"时，该字段为必填项- 对于继承的objects或发现的objects，该字段为只读 |
| value_type | integer | 监控项的信息类型。 可选值： 0 - 数值型float; 1 - 字符型; 2 - 日志型; 3 - 无符号数值型; 4 - 文本型; 5 - 二进制型。 属性行为: - 对create操作是必填项 - 对继承的objects或发现的objects是只读项 |
| allow_traps | integer | 允许像监控项采集器一样填充数值。 0 - （默认） 不允许接收传入数据； 1 - 允许接收传入数据。 属性行为: - 当 type设置为"HTTP agent"时支持- 对于发现的objects为只读 |
| authtype | integer | 认证方式。 当 type设置为"SSH agent"时的可选值：0 - (默认) 密码认证； 1 - 公钥认证。 当 type设置为"HTTP agent"时的可选值：0 - (默认) 无认证； 1 - 基础认证； 2 - NTLM认证； 3 - Kerberos认证。 属性行为: - 支持 当 type设置为"SSH agent"或"HTTP agent"时- 只读 对于继承的objects（当 type设置为"HTTP agent"时）或发现的objects |
| description | string | 监控项的描述。 属性行为: - 对已发现的objects为只读 |
| error | string | 更新监控项值时若出现问题显示的错误文本。 属性行为: - 只读 |
| flags | integer | 监控项的起源。 可选值： 0 - 普通监控项; 4 - 已发现的监控项. 属性行为: - 只读 |
| follow_redirects | integer | 轮询数据时跟随响应重定向。 可选值： 0 - 不跟随重定向； 1 - (默认) 跟随重定向。 属性行为: - 当 type设置为"HTTP agent"时支持此功能- 对于继承的objects或发现的objects为只读属性 |
| headers | array | 执行HTTP请求时将发送的headers的array 属性行为: - 当 type设置为"HTTP agent"时支持- 对于继承的objects或发现的objects为只读 |
| history | string | 历史数据应存储的时间单位。 同时支持用户宏。 默认值：31天。 属性行为: - 对于已发现的objects为只读属性 |
| http_proxy | string | HTTP(S) proxy 连接 string。 属性行为: - 支持 当 type 设置为 "HTTP agent" 时- 只读 对于继承的 objects 或发现的 objects |
| inventory_link | integer | 由监控项填充的主机资产字段ID。 有关支持的主机资产字段及其ID列表，请参阅主机资产清单。 默认值：0。 属性行为: - 当 value_type设置为"数值float"、"字符"、"无符号数值"或"文本"时支持- 对于发现的objects为只读 |
| ipmi_sensor | string | IPMI传感器。 属性行为: - 必填 当 type设置为"IPMI agent"且key_未设置为"ipmi.get"时- 支持 当 type设置为"IPMI agent"时- 只读 对于继承的objects或发现的objects |
| jmx_endpoint | string | JMX agent 自定义连接 string。 默认值：service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi 属性行为: - 支持 当 type 设置为"JMX agent"时- 只读 对于发现的 objects |
| lastclock | timestamp | 监控项值最后更新的时间。 默认仅显示最近24小时内的数值。可通过修改图形用户界面菜单部分中的最大历史显示周期参数来延长该时间段。 属性行为: - 只读 |
| lastns | integer | 上次更新监控项值的纳秒时间戳。 默认仅显示最近24小时内的数值。可通过修改图形用户界面菜单章节中的最大历史显示周期参数来延长该时间段。 属性行为: - 只读 |
| lastvalue | string | 监控项的最新值。 默认情况下，仅显示最近24小时内的数值。您可以通过修改图形用户界面菜单部分中的最大历史显示周期参数来延长此时间段。 属性行为: - 只读 |
| logtimefmt | string | 日志条目中的时间格式。 属性行为: - 当 value_type设置为"log"时支持- 对于继承的objects或发现的objects为只读 |
| master_itemid | ID | 主监控项的ID。 允许递归最多3个依赖监控项，且依赖监控项的最大数量可达29999。 属性行为: - 当 type设置为"依赖主监控项"时，该字段为必填项- 对于继承的objects或发现的objects，该字段为只读 |
| output_format | integer | 响应是否应转换为JSON格式。 0 - (默认) 保留原始数据； 1 - 转换为JSON格式。 属性行为: - 支持 当 type 设置为"HTTP agent"时- 只读 适用于继承的 objects 或发现的 objects |
| params | string | 根据监控项类型所需的附加参数： - 针对SSH agent和TELNET agent 监控项需提供执行脚本； - 数据库监控监控项需提供SQL query； - 计算型监控项需提供计算公式； - 脚本及浏览器监控项需提供对应脚本。 属性行为： - 当 type设置为"数据库监控"、"SSH agent"、"TELNET agent"、"计算型"、"脚本"或"浏览器"时必填- 对于继承的objects（当 type设为"脚本"或"浏览器"时）或发现的objects为只读 |
| parameters | object/array | 当type设置为"Script"或"Browser"时的附加参数。包含name和value属性的arrayobjects，其中name必须唯一。属性行为: - 当 type设置为"Script"或"Browser"时支持- 对于继承的objects或发现的objects为只读 |
| password | string | 认证密码。 属性行为: - 必填 当 type 设置为"JMX agent"且 username 已配置时- 支持 当 type 设置为"简单检查"、"SSH agent"、"TELNET agent"、"数据库监控"或"HTTP agent"时- 只读 对于继承的objects（当 type 设置为"HTTP agent"时）或发现的objects |
| post_type | integer | 存储在posts属性中的POST请求数据类型。可选值： 0 - (默认) 原始数据； 2 - JSON格式数据； 3 - XML格式数据。 属性行为： - 仅当 type设置为"HTTP agent"时支持- 对于继承的objects或自动发现的objects为只读 |
| posts | string | HTTP(S)请求正文数据。 属性行为: - 必填 当 type设置为"HTTP agent"且post_type设置为"JSON数据"或"XML数据"时- 支持 当 type设置为"HTTP agent"且post_type设置为"原始数据"时- 只读 对于继承的objects或发现的objects |
| prevvalue | string | 监控项的先前值。 默认情况下，仅显示最近24小时内的数值。您可以通过修改图形用户界面菜单部分中的最大历史显示周期参数来延长此时间段。 属性行为: - 只读 |
| privatekey | string | 私钥名称 file。 属性行为: - 当 type 设置为"SSH agent" 且 authtype 设置为"公钥"时 必填- 对于已发现的 objects 为 只读 |
| publickey | string | 公钥名称 file。 属性行为: - 当 type 设置为"SSH agent" 且 authtype 设置为"公钥"时，该字段为必填项- 对于已发现的 objects 该字段为只读 |
| query_fields | array | 执行HTTP请求时将发送的query字段的array 属性行为: - 当 type设置为"HTTP agent"时支持- 对于继承的objects或发现的objects为只读 |
| request_method | integer | 请求方法类型。 可选值： 0 - （默认） GET； 1 - POST； 2 - PUT； 3 - HEAD。 属性行为： - 当 type设置为"HTTP agent"时支持- 对于继承的objects或发现的objects为只读 |
| retrieve_mode | integer | 应存储响应的哪部分内容。 当 request_method设置为"GET"、"POST"或"PUT"时的可选值：0 - (默认) 正文； 1 - 头部信息； 2 - 正文和头部信息都将被存储。 当 request_method设置为"HEAD"时的可选值：1 - 头部信息。 属性行为: - 若 type设置为"HTTP agent"则支持- 对于继承的objects或发现的objects为只读 |
| snmp_oid | string | SNMP OID。 属性行为: - 必填 当 type 设置为 "SNMP agent" 时- 只读 对于继承的 objects 或发现的 objects |
| ssl_cert_file | string | 公钥SSL证书file路径。 属性行为: - 支持 当 type设置为"HTTP agent"时- 只读 对于继承的objects或发现的objects |
| ssl_key_file | string | 私有SSL密钥file路径。 属性行为: - 支持 当 type设置为"HTTP agent"时- 只读 对于继承的objects或发现的objects |
| ssl_key_password | string | SSL密钥密码file。 属性行为: - 当 type设为"HTTP agent"时支持- 对继承的objects或发现的objects为只读 |
| state | integer | 监控项的状态。 可能取值： 0 - （默认） 正常； 1 - 不支持。 属性行为： - 只读 |
| status | integer | 监控项的状态。 可能取值： 0 - (默认) 启用监控项; 1 - 禁用监控项。 |
| status_codes | string | 所需HTTP状态码范围，以逗号分隔。 支持在逗号分隔列表中使用用户宏。 示例：200,200-{$M},{$M},200-400 属性行为: - 当 type设置为"HTTP agent"时支持- 对于继承的objects或发现的objects为只读 |
| templateid | ID | 父模板监控项的ID。 提示：使用 hostid属性指定监控项所属的模板。属性行为: - 只读 |
| timeout | string | 监控项 数据轮询请求超时。 接受秒数或带后缀的时间单位（例如30s、1m）。也接受用户宏。 取值范围：1-600s。 默认值："" - 使用proxy/全局设置。 属性行为: - 支持 当 type设置为"Zabbix agent"(0)、"简单检查"(3)且key_不以"vmware."和"icmpping"开头时，以及"Zabbix agent(主动式)"(7)、"外部检查"(10)、"数据库监控"(11)、"SSH agent"(13)、"TELNET agent"(14)、"HTTP agent"(19)、"SNMP agent"(20)且snmp_oid以"walk["或"get["开头时，以及"脚本"(21)、"浏览器"(22)- 只读 对于继承和发现的objects |
| trapper_hosts | string | 允许的主机。 属性行为: - 对于发现的objects为只读 - 当 type设置为"Zabbix trapper"时支持，或当type设置为"HTTP agent"且allow_traps设置为"允许接收传入数据"时支持 |
| trends | string | 趋势数据应存储的时间单位。 同时支持用户宏。 默认值：365天。 属性行为: - 当 value_type设置为"数值型float"或"无符号数值型"时支持- 对于自动发现的objects为只读 |
| units | string | 数值单位。 属性行为: - 当 value_type设置为"数值型float"或"无符号数值型"时支持- 对于继承的objects或发现的objects为只读 |
| username | string | 认证用户名。 属性行为: - 必填 当 type设置为"SSH agent"、"TELNET agent"，或type设置为"JMX agent"且password启用时- 支持 当 type设置为"简单检查"、"数据库监控"或"HTTP agent"时- 只读 对于继承的objects（当 type设置为"HTTP agent"时）或发现的objects |
| uuid | string | 通用唯一标识符，用于将导入的监控项与现有项关联。若未提供则自动生成。 属性行为: - 当监控项属于模板时支持该功能 |
| valuemapid | ID | 关联值映射的ID。 属性行为: - 支持 当 value_type设置为"数值型float"、"字符型"或"无符号数值型"时- 只读 对于继承的objects或发现的objects |
| verify_host | integer | 是否验证连接中的主机名称与主机证书中的名称匹配。 可选值： 0 - （默认） 不验证； 1 - 验证。 属性行为： - 支持 当 type设置为"HTTP agent"时- 只读 对于继承的objects或发现的objects |
| verify_peer | integer | 是否验证主机证书的真实性。 可选值： 0 - (默认) 不验证； 1 - 验证。 属性行为： - 支持 当 type设置为"HTTP agent"时- 只读 对于继承的objects或发现的objects |
HTTP请求头
标题 object 具有以下属性：
HTTP查询字段
query字段object用于定义指定URL参数的名称和值。 它具有以下属性：
监控项 标签
监控项标签object具有以下属性。
预处理
监控项预处理object具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| type | integer | 预处理选项类型。 可能的值： 1 - 自定义乘数； 2 - 右侧裁剪； 3 - 左侧裁剪； 4 - 裁剪； 5 - 正则表达式； 6 - boolean 转十进制； 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； 25 - 替换； 26 - 检查不支持的状态； 27 - XML转JSON； 28 - SNMP walk值； 29 - SNMP walk转JSON； 30 - SNMP get值。 属性行为： - 必填 |
| 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 get 值”（30）时为必填。 |
| error_handler | integer | 预处理步骤失败时使用的操作类型。 可能的值： 0 - 错误信息由 Zabbix server 设置； 1 - 丢弃值； 2 - 设置自定义值； 3 - 设置自定义错误信息。 如果 type 设置为 "Check unsupported" 时的可能值：1 - 丢弃值； 2 - 设置自定义值； 3 - 设置自定义错误信息。 属性行为： - 如果 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）或 "SNMP get value"（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 | 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 integer 或浮点数 2 string 3 正则表达式 4 JSONPath 或 XML XPath 5 正数 integer（支持时间后缀，例如 30s、1m、2h， 1d) 6 用户宏 7 Prometheus 模式，遵循以下语法： <metric name>{<label name>="<label value>", ...} == <value>. 每个 Prometheus模式组件（指标、标签名称、标签值和指标 值）可以是用户宏。 8 Prometheus 输出遵循如下语法：如果选择 label 作为第二个参数，则使用 <label name>（可以是用户宏）。 9 聚合函数之一：sum、min、max、avg、count，如果第二个参数选择的是 function。 10 支持多个由换行符分隔的“字段名、OID前缀、格式记录”记录。