监控项 object

以下objects与itemAPI直接相关。

监控项

Web 监控项 无法直接通过 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}, {HOST.PORT}, {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"时
- 只读 对于已发现的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 历史数据应存储的时间单位。
同时支持用户宏。

默认值:31d。

属性行为:
- 对于已发现的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小时内的值。您可以通过修改图形用户界面菜单部分中的Max history display period参数值来延长此时间段。

属性行为:
- 只读
logtimefmt string 日志条目中的时间格式。

属性行为:
- 当value_type设置为"log"时支持
- 对于继承的objects或发现的objects为只读
master_itemid ID 主监控项的ID。

属性行为:
- 当type设置为"依赖监控项"时必填
- 对于继承的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"时的附加参数。包含namevalue属性的array的objects,其中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 设为 "public key" 时
- 只读 对于已发现的 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-600秒.

默认值: "" - 使用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 趋势数据应存储的时间单位。
同时支持用户宏。

默认值: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设置为"简单检查"、"数据库监控"或"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 具有以下属性:

属性 数据类型 描述
name string HTTP头部名称.

属性行为:
- 必填
value string 头部值.

属性行为:
- 必填

HTTP查询字段

query字段object用于定义指定URL参数的名称和值. 它具有以下属性:

属性 数据类型 描述
name string 参数名称.

属性行为:
- 必填
value string 参数值.

属性行为:
- 必填

监控项 标签

监控项标签object具有以下属性.

属性 数据类型 描述
tag string 监控项标签名称.

属性行为:
- 必填
value string 监控项标签值.

预处理

监控项预处理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设置为“检查不支持”时的可能值:
1 - 丢弃值;
2 - 设置自定义值;
3 - 设置自定义错误消息。

属性行为
- 必填,如果type设置为“自定义乘数”(1)、“正则表达式”(5)、“boolean转十进制”(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 get值”(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 name>(可以是用户宏),如果label被选为第二个参数。
9 聚合函数之一:summinmaxavgcount,如果function被选为第二个参数。
10 支持多个“字段名,OID前缀,格式记录”记录,由换行符分隔。