Documentation
Table of Contents
监控项 原型 object
以下 objects 与 itemprototype API 直接相关。
监控项原型
监控项原型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 | 所属主机的ID，监控项原型所属的ID 属性行为: - constant - required，用于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}、{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"，则为 supported- 对于继承的 objects，则为 read-only |
| headers | array | 发送HTTP请求时将使用的请求头的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"，则为 supported- 对于继承的 objects 为 read-only |
| master_itemid | ID | 主服务器的监控项 ID。 允许递归至最多3个依赖的监控项和监控项原型，且依赖的监控项和监控项原型的最大数量等于29999。 属性行为： - 如果 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"，则为必填的附加参数。包含 objects 的 array，具有 name 和 value 属性，其中 name 必须唯一。属性行为: - supported 如果 type 设置为 "Script" 或 "Browser"- read-only 对于继承的 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 | 私钥文件的名称。 属性行为: - 如果将 type 设为 "SSH agent" 且将 authtype 设为 "公钥"，则此项为必填 |
| publickey | string | 公钥文件的名称。 属性行为: - 如果将 type 设为 "SSH agent" 且将 authtype 设为 "public key"，则此项为必填 |
| query_fields | array | query字段的array，在执行HTTP请求时将被发送。 属性行为: - 如果 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 - (默认) 响应正文（Body）； 1 - 响应头（Headers）； 2 - 同时存储正文和响应头。 如果将 request_method 设置为 "HEAD"，可能的取值包括：1 - 响应头（Headers）。 属性行为: - 如果 type 设置为 "HTTP agent"，则支持该选项；- 对于继承的 objects，该选项为只读。 |
| snmp_oid | string | SNMP OID 属性行为: - 必填 若 type 设置为 "SNMP agent"- 对继承的 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密钥文件的密码。 属性行为: - 如果将 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-600s。 默认值："" - 使用 proxy/全局设置。 属性行为: - 当 type 设置为 "Zabbix agent"（0）、"Simple check"（3）且 key_ 不以 "vmware." 和 "icmpping" 开头时，为 supported- 当为 "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[" 开头时，为 supported- "Script"（21）、"Browser"（22） - 对于继承的 objects 为 read-only |
| trapper_hosts | string | 允许 主机。 属性行为： - 如果将 type 设为 "Zabbix trapper"，或者将 type 设为 "HTTP agent" 且将 allow_traps 设为 "Allow to accept incoming data"，则为 supported。 |
| trends | string | 趋势数据应存储多长时间的时间单位。 同时也接受用户宏和LLD宏。 默认值：365天。 属性行为: - 如果将 value_type 设置为 "numeric float" 或 "numeric unsigned"，则为 supported |
| units | string | 值单位。 属性行为: - 如果将 value_type 设置为“numeric float”或“numeric unsigned”，则为支持- 对于继承的 objects 为只读 |
| username | string | 认证用户名。 属性行为: - 如果 type 设置为 "SSH agent" 或 "TELNET agent"，或者 type 设置为 "JMX agent" 且 password 已设置，则为必填- 如果 type 设置为 "Simple check"、"Database monitor" 或 "HTTP agent"，则为支持- 对于继承的 objects 为只读（如果 type 设置为 "HTTP agent"） |
| uuid | string | 通用唯一标识符，用于将导入的监控项原型与已存在的关联起来。如果不提供，则自动生成。 属性行为: - 如果监控项原型属于模板，则为支持 |
| valuemapid | ID | 关联值映射的ID。 属性行为: - 如果 value_type设置为"numeric float"、"character"或"numeric unsigned"，则为supported- 对于继承的objects，则为read-only |
| verify_host | integer | 是否验证连接的主机名称与主机证书中的名称匹配。 可能的值： 0 - (默认) 不验证； 1 - 验证。 属性行为: - 支持 如果 type设置为 "HTTP agent"- 只读 对于继承的objects |
| verify_peer | integer | 是否验证 主机 证书的真实性。 可能的值： 0 - (默认) 不验证； 1 - 验证。 属性行为： - 如果 type 设置为 "HTTP agent"，则为 supported- 对于继承的 objects 为 read-only |
| discover | integer | 监控项 原型发现状态。 可能的值： 0 - (默认) 将发现新的 监控项； 1 - 不会发现新的 监控项，并且现有的 监控项 将被标记为丢失。 |
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 用户宏，LLD宏 7 Prometheus 模式，遵循以下语法： <metric name>{<label name>="<label value>", ...} == <value>. 每个 Prometheus模式组件（指标、标签名称、标签值和指标 值）可以是用户宏或LLD宏。 8 Prometheus 输出遵循以下语法：<label name>（可以是用户宏或LLD宏），如果选择 label 作为 第二个参数。 9 以下聚合函数之一：sum、min、max、avg、count，如果选择 function 作为第二个参数 参数 10 支持多个由换行符分隔的“字段名、OID前缀、格式记录”记录。