Documentation
Table of Contents
监控项 object
以下 objects 直接与 item API 相关。
监控项
::: noteclassic Web 监控项 无法通过 Zabbix API 直接创建、更新或删除。 仅返回OutputFormat格式要求结果
术语 监控项 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）、"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。 属性行为: - constant - 用于 create 操作的 required 参数 |
| 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 | 允许以类似于 trapper 的方式填充值 监控项。 0 - (默认) 不允许接收传入数据； 1 - 允许接收传入数据。 属性行为: - 如果将 type 设置为 "HTTP agent"，则为 supported；- 对于发现的 objects 为 read-only。 |
| 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"，则为 supported- 对于继承的 objects 或发现的 objects，则为 read-only |
| headers | array | 发送HTTP请求时将发送的请求头 array。 属性行为: - 如果将 type 设为 "HTTP agent"，则该选项为“受支持”- 对于继承的 objects 或发现的 objects，则为“只读” |
| history | string | 历史数据应存储多长时间的时间单位。 也接受用户宏。 默认值：31d。 属性行为: - 对于发现的 objects 为只读 |
| http_proxy | string | HTTP(S) proxy 连接 string。 属性行为： - 如果将 type 设为 "HTTP agent"，则为 支持- 对于继承的 objects 或发现的 objects 为 只读 |
| inventory_link | integer | 由 监控项 填充的 主机 资产字段的 ID。 有关支持的 主机 资产字段及其 ID 列表，请参考 主机资产清单。 默认值：0。 属性行为： - 如果 value_type 设置为 "numeric float"、"character"、"numeric unsigned" 或 "text"，则为 supported- 对于发现的 objects 为 read-only |
| 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 小时内的值。您可以通过更改 图形用户界面 菜单部分中的 Max history display period 参数来延长此时间段。 属性行为: - 只读 |
| lastns | integer | 上次更新 监控项 值时的纳秒时间戳。 默认情况下，仅显示最近 24 小时内的值。您可以通过更改 图形用户界面 菜单部分中的 Max history display period 参数来延长此时间段。 属性行为: - read-only |
| lastvalue | string | 最近一次 监控项 的值。 默认情况下，仅显示最近 24 小时内的值。您可以通过更改 图形用户界面 菜单部分中的 Max history display period 参数来延长此时间段。 属性行为： - 只读 |
| logtimefmt | string | 日志条目中时间的格式。 属性行为: - 如果将 value_type 设为 "log"，则为 supported- 对于继承的 objects 或发现的 objects 为 read-only |
| master_itemid | ID | 主服务器的 监控项 ID。 允许递归向上至 3 个依赖的 监控项，且依赖的 监控项 最大数量等于 29999。 属性行为: - 如果 type 设置为 "Dependent 监控项"，则为必填- 对于继承的 objects 或发现的 objects 为只读 |
| output_format | integer | 响应是否应转换为 JSON。 0 - (默认) 存储原始数据； 1 - 转换为 JSON。 属性行为: - 若 type 设置为 "HTTP agent" 则 支持- 对于继承的 objects 或发现的 objects 则为 只读 |
| params | string | 根据监控项类型的附加参数： - SSH agent 和 TELNET agent 监控项 的执行脚本； - 数据库监控 监控项 的 SQL query； - 计算型 监控项 的公式； - 脚本和浏览器 监控项 的脚本。 属性行为： - 如果 type 设置为 "Database monitor"、"SSH agent"、"TELNET agent"、"Calculated"、"Script" 或 "Browser"，则为 必填- 对于继承的 objects（如果 type 设置为 "Script" 或 "Browser"）或发现的 objects 为 只读 |
| parameters | object/array | 如果将 type 设置为 "Script" 或 "Browser"，则为附加参数。包含 objects 的 array，具有 name 和 value 属性，其中 name 必须唯一。属性行为: - supported 如果将 type 设置为 "Script" 或 "Browser"- read-only 对于继承的 objects 或发现的 objects |
| password | string | 认证用的密码。 属性行为: - 若 type 设置为 "JMX agent" 且 username 已设置，则为必填- 若 type 设置为 "Simple check"、"SSH agent"、"TELNET agent"、"Database monitor" 或 "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 小时内的值。您可以通过更改 图形用户界面 菜单部分中的 Max history display period 参数来延长此时间段。 属性行为: - 只读 |
| privatekey | string | 私钥文件的名称。 属性行为: - 如果将 type 设置为 "SSH agent" 且将 authtype 设置为 "公钥"，则此字段必填- 对于发现的 objects，此字段为只读 |
| publickey | string | 公钥文件的名称。 属性行为: - 如果将 type 设置为 "SSH agent" 且将 authtype 设置为 "public key"，则此参数必填- 对于发现的 objects，此参数为只读 |
| query_fields | array | query字段的array，在执行HTTP请求时将被发送。 属性行为: - 如果 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 - (默认) 响应正文（Body）； 1 - 响应头（Headers）； 2 - 同时存储响应正文和响应头。 如果将 request_method 设置为 "HEAD"，可能的取值如下：1 - 响应头（Headers）。 属性行为: - 当 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密钥文件的密码。 属性行为: - 如果将 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"，则为 supported- 对于继承的 objects 或发现的 objects，则为 read-only |
| 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）时为 支持- 继承和发现的 objects 为 只读 |
| trapper_hosts | string | 允许 主机。 属性行为： - 对于发现的 objects 为 只读 - 如果将 type 设为 "Zabbix trapper"，或如果将 type 设为 "HTTP agent" 且将 allow_traps 设为 "允许接受传入数据"，则为 支持 |
| trends | string | 趋势数据应存储多长时间的时间单位。 也接受用户宏。 默认值：365d。 属性行为: - 如果 value_type 设置为 "numeric float" 或 "numeric unsigned"，则为支持- 对于发现的 objects 为只读 |
| units | string | 值单位。 属性行为: - 如果 value_type 设置为 "numeric float" 或 "numeric unsigned"，则为 支持- 对于继承的 objects 或发现的 objects，则为 只读 |
| username | string | 认证用户名。 属性行为: - 如果将 type 设为 "SSH agent"、"TELNET agent"，或将 type 设为 "JMX agent" 且 password 已设置，则为必填- 如果将 type 设为 "Simple check"、"Database monitor" 或 "HTTP agent"，则为支持- 对于继承的 objects（如果将 type 设为 "HTTP agent"）或发现的 objects，则为只读 |
| uuid | string | 通用唯一标识符，用于将导入的监控项与已存在的关联起来。若未提供则自动生成。 属性行为: - 若监控项属于模板，则为支持 |
| valuemapid | ID | 关联值映射的ID。 属性行为: - 如果 value_type设置为"numeric float"、"character"或"numeric unsigned"，则为supported- 对于继承的objects或发现的objects，则为read-only |
| verify_host | integer | 是否验证连接的主机名称与主机证书中的名称匹配。 可能的值： 0 - (默认) 不验证； 1 - 验证。 属性行为: - 如果 type设置为 "HTTP agent"，则为支持- 对于继承的objects或发现的objects，则为只读 |
| verify_peer | integer | 是否验证 主机 证书的真实性。 可能的值： 0 - (默认) 不验证； 1 - 验证。 属性行为： - 如果 type 设置为 "HTTP agent"，则为 supported；- 对于继承的 objects 或发现的 objects 为 read-only。 |
HTTP请求头
标题 object 具有以下属性：
{HEADER_72572905}
字段 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前缀、格式记录”记录。