监控项原型 object

以下objects与itemprototypeAPI直接相关.

监控项原型

监控项原型object具有以下特性

属性	数据类型	描述
itemid	ID	监控项原型的ID. 属性行为: - 只读 - 必需用于update操作
delay	string	监控项原型的更新间隔. 接受秒数或带后缀的时间单位（例如30s、1m、2h、1d），并可选择性地包含一个或多个custom intervals，各项之间用分号分隔。自定义间隔可以是弹性间隔和调度间隔的混合形式. 接受用户宏和LLD宏。如果使用宏，其值必须为单个宏。不支持多个宏或宏与文本混合的形式。弹性间隔可以写成用斜杠分隔的两个宏（例如`{$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	监控项原型所属的主机标识符。属性行为: - 常量 - 进行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"时
key_	string	监控项原型键. 属性行为: - 必填用于 create 操作 - 只读用于继承的 objects
name	string	监控项原型名称. 支持用户宏. 属性行为: - 对于create操作是必填项 - 对于继承的objects是只读项
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 trap; 18 - 依赖型监控项; 19 - HTTP agent; 20 - SNMP agent; 21 - 脚本; 22 - 浏览器. 属性行为: - 必填用于create操作 - 只读用于继承的objects
url	string	URL string. 支持LLD宏、用户宏、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}. 属性行为: - 必填当`type`设置为"HTTP agent"时 - 只读对于继承的objects
value_type	integer	监控项原型的信息类型. 可能取值: 0 - 数值型float; 1 - 字符型; 2 - 日志型; 3 - 无符号数值型; 4 - 文本型; 5 - 二进制型. 属性行为: - 对于create操作是必填项 - 对于继承的objects是只读项
allow_traps	integer	允许以类似trapper 监控项的方式填充值. 0 - (默认) 不允许接收传入数据; 1 - 允许接收传入数据. 属性行为: - 支持当`type`设置为"HTTP agent"时
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"时)
description	string	监控项原型描述.
follow_redirects	integer	轮询数据时跟随响应重定向。可选值： 0 - 不跟随重定向； 1 - (默认) 跟随重定向。属性行为: - 当`type`设置为"HTTP agent"时支持 - 对于继承的objects为只读
headers	array	执行HTTP请求时将发送的headers的array. 属性行为: - 当`type`设置为"HTTP agent"时支持 - 对于继承的objects为只读
history	string	历史数据应存储的时间单位。同时支持用户宏和LLD宏。默认值: 31d.
http_proxy	string	HTTP(S) proxy 连接 string. 属性行为: - 支持当 `type` 设置为 "HTTP agent" - 只读对于继承的 objects
ipmi_sensor	string	IPMI传感器. 属性行为: - 必填当`type`设置为"IPMI agent"且`key_`未设置为"ipmi.get"时 - 支持当`type`设置为"IPMI agent"时 - 只读对于继承的objects
jmx_endpoint	string	JMX agent 自定义连接 string. 默认值: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi 属性行为: - 支持当 `type` 设置为 "JMX agent" 时
logtimefmt	string	日志条目中的时间格式. 属性行为: - 当`value_type`设置为"log"时支持 - 对于继承的objects为只读
master_itemid	ID	主监控项的ID. 属性行为: - 当`type`设置为"依赖监控项"时必填 - 对于继承的objects为只读
output_format	integer	响应是否应转换为JSON. 可选值: 0 - (默认) 存储原始数据; 1 - 转换为JSON. 属性行为: - 支持当 `type` 设置为"HTTP agent"时 - 只读对于继承的 objects
params	string	根据监控项原型类型的不同附加参数: - SSH agent和TELNET agent 监控项原型的执行脚本; - 数据库监控监控项原型的SQL query; - 计算型监控项原型的公式; - 脚本和浏览器监控项原型的脚本. 属性行为: - 当`type`设置为"Database monitor"、"SSH agent"、"TELNET agent"、"Calculated"、"Script"或"Browser"时必填 - 对于继承的objects为只读(当`type`设置为"Script"或"Browser"时)
parameters	object/array	当`type`设置为"Script"或"Browser"时的附加参数。包含`name`和`value`属性的array的objects，其中`name`必须唯一。属性行为: - 当`type`设置为"Script"或"Browser"时支持 - 对于继承的objects为只读
password	string	认证密码. 属性行为: - 必填当 `type` 设置为"JMX agent"且 `username` 已设置时 - 支持当 `type` 设置为"简单检查"、"SSH agent"、"TELNET agent"、"数据库监控"或"HTTP agent"时 - 只读对于继承的objects (当 `type` 设置为"HTTP agent"时)
post_type	integer	存储在`posts`属性中的POST请求体数据类型. 可选值: 0 - (默认) 原始数据. 2 - JSON数据. 3 - XML数据. 属性行为: - 支持当`type`设置为"HTTP agent"时 - 只读对于继承的objects
posts	string	HTTP(S)请求正文数据. 属性行为: - 必填当`type`设置为"HTTP agent"且`post_type`设置为"JSON数据"或"XML数据"时 - 支持当`type`设置为"HTTP agent"且`post_type`设置为"原始数据"时 - 只读对于继承的objects
privatekey	string	私钥名称 file. 属性行为: - 必填当 `type` 设为"SSH agent"且 `authtype` 设为"公钥"时
publickey	string	公钥名称 file. 属性行为: - 必填当 `type` 设为"SSH agent"且 `authtype` 设为"public key"时
query_fields	array	执行HTTP请求时将发送的query字段的array. 属性行为: - 当`type`设置为"HTTP agent"时支持 - 对于继承的objects为只读
request_method	integer	请求方法类型. 可选值: 0 - (默认) GET; 1 - POST; 2 - PUT; 3 - HEAD. 属性行为: - 支持当 `type` 设置为"HTTP agent"时 - 只读对于继承的 objects
retrieve_mode	integer	应存储响应的哪部分内容. 当`request_method`设置为"GET"、"POST"或"PUT"时的可选值: 0 - (默认) 正文; 1 - 头部; 2 - 同时存储正文和头部. 当`request_method`设置为"HEAD"时的可选值: 1 - 头部. 属性行为: - 当`type`设置为"HTTP agent"时支持 - 对于继承的objects为只读
snmp_oid	string	SNMP OID. 属性行为: - required 如果 `type` 设置为 "SNMP agent" - read-only 对于继承的 objects
ssl_cert_file	string	公钥SSL证书file路径. 属性行为: - 支持当`type`设置为"HTTP agent"时 - 只读对于继承的objects
ssl_key_file	string	私有SSL密钥file路径. 属性行为: - 支持当`type`设置为"HTTP agent"时 - 只读对于继承的objects
ssl_key_password	string	SSL密钥密码 file. 属性行为: - 支持当 `type` 设置为 "HTTP agent" 时 - 只读对于继承的 objects
status	integer	监控项原型状态. 可能取值: 0 - (默认) 启用监控项原型; 1 - 禁用监控项原型; 3 - 不支持的监控项原型.
status_codes	string	以逗号分隔的所需HTTP状态码范围。支持在逗号分隔列表中使用用户宏或LLD宏。示例：200,200-{$M},{$M},200-400 属性行为: - 当`type`设置为"HTTP agent"时支持 - 继承的objects为只读
templateid	ID	父模板监控项原型的ID。属性行为: - 只读
timeout	string	监控项数据轮询请求超时。接受秒数或带后缀的时间单位（例如30s、1m）。同时支持用户宏和LLD宏。取值范围：1-600秒。默认值："" - 使用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	允许的主机. 属性行为: - 支持当 `type` 设置为 "Zabbix trapper"，或当 `type` 设置为 "HTTP agent" 且 `allow_traps` 设置为 "允许接收传入数据"
trends	string	趋势数据应存储的时间单位。同时接受用户宏和LLD宏。默认值：365d。属性行为: - 支持当`value_type`设置为"numeric float"或"numeric unsigned"时
units	string	数值单位. 属性行为: - 当`value_type`设置为"numeric float"或"numeric unsigned"时支持 - 对于继承的objects为只读
username	string	认证用户名. 属性行为: - 必填当`type`设置为"SSH agent"或"TELNET agent"时，或当`type`设置为"JMX agent"且`password`已配置时 - 支持当`type`设置为"简单检查"、"数据库监控"或"HTTP agent"时 - 只读对于继承的objects（当`type`设置为"HTTP agent"时）
uuid	string	通用唯一标识符，用于将导入的监控项原型与已存在的条目关联。若未提供则自动生成。属性行为: - 当监控项原型属于模板时支持该功能
valuemapid	ID	关联值映射的ID。属性行为: - 支持当`value_type`设置为"数值float"、"字符"或"无符号数值"时 - 只读对于继承的objects
verify_host	integer	是否验证连接中的主机名称与主机证书中的名称匹配. 可选值: 0 - (默认) 不验证; 1 - 验证. 属性行为: - 支持当`type`设置为"HTTP agent"时 - 只读对于继承的objects
verify_peer	integer	是否验证主机证书的真实性. 可选值: 0 - (默认) 不验证; 1 - 验证. 属性行为: - 支持当`type`设置为"HTTP agent"时 - 只读对于继承的objects
discover	integer	监控项原型发现状态. 可能值: 0 - (默认) 新监控项将被发现; 1 - 新监控项将不会被发现且现有监控项将被标记为丢失.

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	number^1, 6			0, 1, 2, 3
2	Right trim	list of characters²
3	Left trim	list of characters²
4	Trim	list of characters²
5	Regular expression	pattern³	output²		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	path⁴			0, 1, 2, 3
12	JSONPath	path⁴			0, 1, 2, 3
13	In range	min^1, 6	max^1, 6		0, 1, 2, 3
14	Matches regular expression	pattern³			0, 1, 2, 3
15	Does not match regular expression	pattern³			0, 1, 2, 3
16	Check for error in JSON	path⁴			0, 1, 2, 3
17	Check for error in XML	path⁴			0, 1, 2, 3
18	Check for error using regular expression	pattern³	output²		0, 1, 2, 3
19	Discard unchanged
20	Discard unchanged with heartbeat	seconds^5, 6
21	JavaScript	script²
22	Prometheus pattern	pattern^6, 7	`value`, `label`, `function`	output^8, 9	0, 1, 2, 3
23	Prometheus to JSON	pattern^6, 7			0, 1, 2, 3
24	CSV to JSON	character²	character²	0,1	0, 1, 2, 3
25	Replace	search string²	replacement²
26	Check unsupported	scope¹	pattern^3, 6		1, 2, 3
27	XML to JSON				0, 1, 2, 3
28	SNMP walk value	OID²	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 JSON¹⁰	Field name²	OID prefix²	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

¹ integer或浮点数
² string
³ 正则表达式
⁴ JSONPath或XML XPath
⁵ 正integer（支持时间后缀，如30s、1m、2h、1d）
⁶ 用户宏、LLD宏
⁷ Prometheus模式，语法如下： <metric name>{<label name>="<label value>", ...} == <value>。每个 Prometheus模式组件（指标、标签名、标签值和指标值）可以是用户宏或LLD宏。
⁸ Prometheus输出，语法如下：<label name>（可以是用户宏或LLD宏），如果label被选为第二个参数。
⁹ 聚合函数之一：sum、min、max、avg、count，如果function被选为第二个参数。
¹⁰ 支持多个"字段名,OID前缀,格式记录"记录，用换行符分隔。

Documentation

监控项 原型 object