以下对象与 监控项原型
API 直接相关。
监控项原型对象具有以下属性。
属性 | 类型 | 描述 |
---|---|---|
itemid | string | (只读) 监控项原型的ID。 |
delay (必需) |
string | 监控项原型的更新间隔。接受秒或带有后缀的时间单位(30s,1m,2h,1d)。 可选地,可以指定一个或多个自定义间隔,可以是灵活的间隔或调度。 多个间隔用分号分隔。 可以使用用户宏和LLD宏。单一宏必须填满整个字段。不支持字段中多个宏或宏与文本混合。 灵活的间隔可以写成两个宏,用正斜杠分隔(例如 {$FLEX_INTERVAL}/{$FLEX_PERIOD} )。对于Zabbix trapper,依赖项和具有 mqtt.get 键的Zabbix agent(主动)是可选的。 |
hostid (必需) |
string | 监控项原型所属的主机ID。 对于更新操作,此字段是只读的。 |
ruleid (必需) |
string | 监控项所属的LLD规则的ID。 对于更新操作,此字段是只读的。 |
interfaceid (必需) |
string | 监控项原型的主机接口ID。仅用于主机监控项原型。 对于Zabbix agent(主动),Zabbix内部,Zabbix trapper,计算,依赖,数据库监视器和脚本监控项原型不是必需的。对于HTTP agent监控项原型是可选的。 |
key_ (必需) |
string | 监控项原型的键。 |
name (必需) |
string | 监控项原型的名称。 |
type (必需) |
integer | 监控项原型的类型。 可能的值: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - 简单检查; 5 - Zabbix内部; 7 - Zabbix agent(主动); 10 - 外部检查; 11 - 数据库监视器; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - 计算; 16 - JMX agent; 17 - SNMP陷阱; 18 - 依赖项; 19 - HTTP agent; 20 - SNMP agent; 21 - 脚本。 |
url (必需) |
string | 仅对HTTP agent监控项原型需要的URL字符串。支持LLD宏,用户宏,{HOST.IP},{HOST.CONN},{HOST.DNS},{HOST.HOST},{HOST.NAME},{ITEM.ID},{ITEM.KEY}。 |
value_type (必需) |
integer | 监控项原型的信息类型。 可能的值: 0 - 数值浮点; 1 - 字符; 2 - 日志; 3 - 数值无符号; 4 - 文本。 |
allow_traps | integer | HTTP agent监控项原型字段。允许像trapper项类型一样填充值。 0 - (默认) 不允许接受传入数据。 1 - 允许接受传入数据。 |
authtype | integer | 仅由SSH agent监控项原型或HTTP agent监控项原型使用。 SSH agent认证方法可能的值: 0 - (默认) 密码; 1 - 公钥。 HTTP agent认证方法可能的值: 0 - (默认) 无 1 - 基础 2 - NTLM 3 - Kerberos |
description | string | 监控项原型的描述。 |
follow_redirects | integer | HTTP agent监控项原型字段。在轮询数据时跟随响应重定向。 0 - 不跟随重定向。 1 - (默认) 跟随重定向。 |
headers | object | HTTP agent监控项原型字段。HTTP(S)请求头的对象,其中头部名称用作键,头部值作为值。 示例: { "User-Agent": "Zabbix" } |
history | string | 历史数据应该存储多长时间的时间单位。也接受用户宏和LLD宏。 默认值:90d。 |
http_proxy | string | HTTP agent监控项原型字段。HTTP(S) agent连接字符串。 |
ipmi_sensor | string | IPMI传感器。仅由IPMI监控项原型使用。 |
jmx_endpoint | string | JMX agent自定义连接字符串。 默认值: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
logtimefmt | string | 日志条目中的时间格式。仅由日志监控项原型使用。 |
master_itemid | integer | 主项ID。 允许递归最多3个依赖项和监控项原型,依赖项和监控项原型的最大数量等于29999。 由依赖项需要。 |
output_format | integer | HTTP agent监控项原型字段。响应是否应转换为JSON。 0 - (默认) 存储原始数据。 1 - 转换为JSON。 |
params | string | 根据监控项原型的类型而变化的附加参数: - SSH和Telnet监控项原型执行的脚本; - 数据库监视器监控项原型的SQL查询; - 计算监控项原型的公式。 |
parameters | array | 脚本监控项原型的附加参数。具有'name'和'value'属性的对象数组,其中名称必须是唯一的。 |
password | string | 认证密码。由简单检查,SSH,Telnet,数据库监视器,JMX和HTTP agent监控项原型使用。 由SSH和Telnet监控项原型需要。 |
post_type | integer | HTTP agent监控项原型字段。存储在posts属性中的post数据正文的类型。 0 - (默认) 原始数据。 2 - JSON数据。 3 - XML数据。 |
posts | string | HTTP agent监控项原型字段。HTTP(S)请求正文数据。与post_type一起使用。 |
privatekey | string | 私钥文件的名称。 |
publickey | string | 公钥文件的名称。 |
query_fields | array | HTTP agent监控项原型字段。查询参数。具有'key':'value'对的对象数组,其中值可以是空字符串。 |
request_method | integer | HTTP agent监控项原型字段。请求方法的类型。 0 - (默认) GET 1 - POST 2 - PUT 3 - HEAD |
retrieve_mode | integer | HTTP agent监控项原型字段。应该存储响应的哪一部分。 0 - (默认) 正文。 1 - 头。 2 - 正文和头都将被存储。 对于request_method HEAD,只允许值1。 |
snmp_oid | string | SNMP OID。 |
ssl_cert_file | string | HTTP agent监控项原型字段。公共SSL密钥文件路径。 |
ssl_key_file | string | HTTP agent监控项原型字段。私有SSL密钥文件路径。 |
ssl_key_password | string | HTTP agent监控项原型字段。SSL密钥文件的密码。 |
status | integer | 监控项原型的状态。 可能的值: 0 - (默认) 启用的监控项原型; 1 - 禁用的监控项原型; 3 - 不支持的监控项原型。 |
status_codes | string | HTTP agent监控项原型字段。所需的HTTP状态代码范围,用逗号分隔。还支持用户宏或LLD宏作为逗号分隔列表的一部分。 示例:200,200-{$M},{$M},200-400 |
templateid | string | (只读) 父模板监控项原型的ID。 |
timeout | string | 监控项数据轮询请求超时。用于HTTP agent和脚本监控项原型。支持用户宏和LLD宏。 默认值:3s 最大值:60s |
trapper_hosts | string | 允许的主机。由trapper监控项原型或HTTP监控项原型使用。 |
trends | string | 趋势数据应该存储多长时间的时间单位。也接受用户宏和LLD宏。 默认值:365d。 |
units | string | 值单位。 |
username | string | 认证用户名。由简单检查,SSH,Telnet,数据库监视器,JMX和HTTP agent监控项原型使用。 由SSH和Telnet监控项原型需要。 |
uuid | string | 通用唯一标识符,用于将导入的监控项原型与已有的原型进行关联。仅在模板上使用监控项原型时使用。如果未提供,则自动生成。 |
valuemapid | string | 相关值映射的ID。 |
verify_host | integer | HTTP agent监控项原型字段。是否验证连接的主机名是否与主机证书中的名称匹配。 0 - (默认) 不进行验证。 1 - 进行验证。 |
verify_peer | integer | HTTP agent监控项原型字段。是否验证主机的证书是否真实有效。 0 - (默认) 不进行验证。 1 - 进行验证。 |
discover | integer | 监控项原型的发现状态。 可能的值: 0 - (默认) 将发现新监控项; 1 - 不会发现新监控项,并将现有监控项标记为丢失。 |
请注意,对于一些方法(更新,删除),所需/可选参数组合是不同的。
监控项原型标签对象具有以下属性。
属性 | 类型 | 描述 |
---|---|---|
tag (必需) |
string | 监控项原型标签名字。 |
value | string | 监控项原型标签值。 |
监控项原型预处理对象具有以下属性。
属性 | 类型 | 描述 |
---|---|---|
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 - 丢弃未更改的内容;<br >20 - 丢弃未更改的心跳; 21 - JavaScript; 22 - Prometheus 模式; 23 - Prometheus 到 JSON; 24 - CSV 到 JSON; 25 - 替换;<br >26 - 检查不支持; 27 - XML 到 JSON。 |
params (必需) |
string | 预处理选项使用的附加参数。多个参数由 LF (\n) 字符分隔。 |
error_handler (必需) |
integer | 在预处理步骤失败的情况下使用的操作类型。 可能的值: 0 - 错误消息由 Zabbix server设置; 1 - 丢弃值; 2 - 设置自定义值; 3 - 设置自定义错误消息。 |
error_handler_params (必需) |
string | 错误处理程序参数。与 error_handler 一起使用。如果 error_handler 为 0 或 1,则必须为空。如果 error_handler 为 2,则可以为空。如果 error_handler 为3,则不能为空。 |
每个都支持以下参数和错误处理程序 预处理类型。
预处理类型 | 名称 | 参数 1 | 参数 2 | 参数 3 | 支持的错误处理程序 |
---|---|---|---|---|---|
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 | Prometheus 转 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 |
1 整数或浮点数
2 字符串
3 正则表达式
4 JSONPath 或 XML XPath
5 正整数(支持时间后缀,例如 30s、1m、2h、1d)
6 用户宏,LLD 宏
7 Prometheus 模式遵循以下语法:<metric name>{<label name>="<label value>", ...} == <value>
。每个Prometheus 模式组件(指标、标签名称、标签值和指标value) 可以是用户宏或 LLD 宏。
8 Prometheus 输出如下语法:<label name>
(可以是用户宏或 LLD 宏)如果选择 label
作为第二个参数。
9 聚合函数之一:sum
、min
、max
、avg
、count
如果function
被选为第二个范围。