Documentation
监控项原型对象
以下对象与 监控项原型 API 直接相关。
监控项原型
监控项原型对象具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| itemid | ID | 监控项原型的ID。 属性行为: - 只读 - 更新操作时必需 |
| delay | string | 监控项原型的更新间隔。 接受秒或带有后缀的时间单位（例如，30s, 1m, 2h, 1d），并且可选地接受一个或多个自定义间隔，所有这些都用分号分隔。自定义间隔可以是灵活间隔和计划间隔的混合。 接受用户宏和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), "简单检查" (3), "Zabbix internal" (5), "External check" (10), "数据库监控" (11), "IPMI客户端" (12), "SSH 客户端" (13), "TELNET客户端" (14), "可计算的" (15), "JMX agent代理程序" (16), "HTTP 代理" (19), "SNMP 代理" (20), "脚本" (21), "Browser" (22)，或者如果type设置为"Zabbix agent (主动式)" (7)且key_不包含"mqtt.get"，则为必需 |
| hostid | ID | 监控项原型所属的主机ID。 属性行为: - 常量 - 创建操作时必需 |
| interfaceid | ID | 监控项原型的主机接口ID。 属性行为: - 如果监控项原型属于主机且 type设置为"Zabbix agent", "IPMI客户端", "JMX agent代理程序", "SNMP trap", 或 "SNMP 代理"，则为必需- 如果监控项原型属于主机且 type设置为"简单检查", "External check", "SSH 客户端", "TELNET客户端", 或 "HTTP 代理"，则为支持 |
| key_ | string | 监控项原型的键。 属性行为: - 创建操作时必需 - 继承对象时只读 |
| name | string | 监控项原型的名称。支持用户宏。 属性行为: - 创建操作时必需 - 继承对象时只读 |
| type | integer | 监控项原型的类型。 可能的值： 0 - Zabbix agent; 2 - Zabbix trapper; 3 - 简单检查; 5 - Zabbix 内部; 7 - Zabbix agent (主动式); 10 - 外部检查; 11 - 数据库监控; 12 - IPMI客户端; 13 - SSH 客户端; 14 - TELNET客户端; 15 - 可计算的; 16 - JMX agent代理程序; 17 - SNMP trap; 18 - 依赖项; 19 - HTTP 代理; 20 - SNMP 代理; 21 - 脚本; 22 - Browser。 属性行为: - 创建操作时必需 - 继承对象时只读 |
| url | string | URL字符串。支持LLD宏、用户宏、{HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}。 属性行为: - 如果 type设置为"HTTP 代理"，则为必需- 继承对象时只读 |
| value_type | integer | 监控项原型的信息类型。 可能的值： 0 - 浮点数; 1 - 字符; 2 - 日志; 3 - 数字（无正负）; 4 - 文本; 5 - 二进制。 属性行为: - 创建操作时必需 - 继承对象时只读 |
| allow_traps | integer | 允许以与陷阱项类似的方式填充值。 0 - (默认) 不允许接受传入数据; 1 - 允许接受传入数据。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持 |
| authtype | integer | 认证方法。 如果 type设置为"SSH 客户端"：0 - (默认) 密码; 1 - 公钥。 如果 type设置为"HTTP 代理"：0 - (默认) 无; 1 - 基本; 2 - NTLM; 3 - Kerberos。 属性行为: - 如果 type设置为"SSH 客户端"或"HTTP 代理"，则为支持- 如果 type设置为"HTTP 代理"，继承对象时只读 |
| description | string | 监控项原型的描述。 |
| follow_redirects | integer | 轮询数据时跟随响应重定向。 可能的值： 0 - 不跟随重定向; 1 - (默认) 跟随重定向。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| headers | array | 执行HTTP请求时将发送的headers数组。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| history | string | 历史数据应存储的时间单位。 也接受用户宏和LLD宏。 默认值：31d。 |
| http_proxy | string | HTTP(S)代理连接字符串。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| ipmi_sensor | string | IPMI传感器。 属性行为: - 如果 type设置为"IPMI客户端"且key_未设置为"ipmi.get"，则为必需- 如果 type设置为"IPMI客户端"，则为支持- 继承对象时只读 |
| jmx_endpoint | string | JMX代理自定义连接字符串。 默认值：service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi 属性行为: - 如果 type设置为"JMX agent代理程序"，则为支持 |
| logtimefmt | string | 日志条目中时间的格式。 属性行为: - 如果 数据类型设置为"log"，则为支持- 继承对象时只读 |
| master_itemid | ID | 主项的ID。 允许最多3个依赖项和监控项原型，以及依赖项和监控项原型的最大数量等于29999。 属性行为: - 如果 type设置为"依赖监控项"，则为必需- 继承对象时只读 |
| output_format | integer | 响应是否应转换为JSON。 可能的值： 0 - (默认) 存储原始数据; 1 - 转换为JSON。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| params | string | 根据监控项原型的类型，附加参数： - 对于SSH代理和TELNET代理监控项原型，执行的脚本; - 对于数据库监控监控项原型，SQL查询; - 对于计算监控项原型，公式; - 对于脚本和Browser监控项原型，脚本。 属性行为: - 如果 type设置为"数据库监控", "SSH 客户端", "TELNET客户端", "可计算的", "脚本", 或 "Browser"，则为必需- 如果 type设置为"脚本"或"Browser"，继承对象时只读 |
| parameters | object/array | 如果type设置为"脚本"或"Browser"，则附加参数。对象数组，具有name和value属性，其中name必须是唯一的。属性行为: - 如果 type设置为"脚本"或"Browser"，则为支持- 继承对象时只读 |
| password | string | 认证密码。 属性行为: - 如果 type设置为"JMX agent代理程序"且设置了username，则为必需- 如果 type设置为"简单检查", "SSH 客户端", "TELNET客户端", "数据库监控", 或 "HTTP 代理"，则为支持- 如果 type设置为"HTTP 代理"，继承对象时只读 |
| post_type | integer | 存储在posts属性中的post数据正文的类型。可能的值： 0 - (默认) 原始数据。 2 - JSON数据。 3 - XML数据。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| posts | string | HTTP(S)请求正文数据。 属性行为: - 如果 type设置为"HTTP 代理"且post_type设置为"JSON data"或"XML data"，则为必需- 如果 type设置为"HTTP 代理"且post_type设置为"Raw data"，则为支持- 继承对象时只读 |
| privatekey | string | 私钥文件的名称。 属性行为: - 如果 type设置为"SSH 客户端"且authtype设置为"public key"，则为必需 |
| publickey | string | 公钥文件的名称。 属性行为: - 如果 type设置为"SSH 客户端"且authtype设置为"public key"，则为必需 |
| query_fields | array | 执行HTTP请求时将发送的query fields数组。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| request_method | integer | 请求方法的类型。 可能的值： 0 - (默认) GET; 1 - POST; 2 - PUT; 3 - HEAD。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| retrieve_mode | integer | 应存储响应的哪一部分。 如果 request_method设置为"GET", "POST", 或 "PUT"：0 - (默认) 正文; 1 - 头部; 2 - 正文和头部都将被存储。 如果 request_method设置为"HEAD"：1 - 头部。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| snmp_oid | string | SNMP OID。 属性行为: - 如果 type设置为"SNMP 代理"，则为必需- 继承对象时只读 |
| ssl_cert_file | string | 公共SSL密钥文件路径。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| ssl_key_file | string | 私有SSL密钥文件路径。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| ssl_key_password | string | SSL密钥文件的密码。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| status | integer | 监控项原型的状态。 可能的值： 0 - (默认) 启用的监控项原型; 1 - 禁用的监控项原型; 3 - 不支持的监控项原型。 |
| status_codes | string | 所需的HTTP状态代码范围，用逗号分隔。 还支持作为逗号分隔列表的一部分的用户宏或LLD宏。 示例：200,200-{$M},{$M},200-400 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| templateid | ID | 父模板监控项原型的ID。 属性行为: - 只读 |
| timeout | string | 监控项数据轮询请求超时。 接受秒或带有后缀的时间单位（例如，30s, 1m）。也接受用户宏和LLD宏。 可能的值范围：1-600s。 默认值："" - 使用代理/全局设置。 属性行为: - 如果 type设置为"Zabbix agent" (0), "简单检查" (3) 且 key_ 不以 "vmware." 和 "icmpping" 开头，"Zabbix agent (主动式)" (7), "External check" (10), "数据库监控" (11), "SSH 客户端" (13), "TELNET客户端" (14), "HTTP 代理" (19), "SNMP 代理" (20) 且 snmp_oid 以 "walk[" 或 "get[" 开头，"脚本" (21), "Browser" (22)，则为支持- 继承对象时只读 |
| trapper_hosts | string | 允许的主机。 属性行为: - 如果 type设置为"Zabbix trapper"，或者如果type设置为"HTTP 代理"且allow_traps设置为"Allow to accept incoming data"，则为支持 |
| trends | string | 趋势数据应存储的时间单位。 也接受用户宏和LLD宏。 默认值：365d。 属性行为: - |
如果数据类型设置为"浮点数t" 或 "数字（无正负）"，则为支持 |
||
| units | string | 值单位。 属性行为: - 如果 数据类型设置为"浮点数t" 或 "数字（无正负）"，则为支持- 继承对象时只读 |
| username | string | 认证用户名。 属性行为: - 如果 type设置为"SSH 客户端" 或 "TELNET客户端"，或者如果type设置为"JMX agent代理程序"且设置了password，则为必需- 如果 type设置为"简单检查", "数据库监控", 或 "HTTP 代理"，则为支持- 如果 type设置为"HTTP 代理"，继承对象时只读 |
| uuid | string | 通用唯一标识符，用于将导入的监控项原型链接到已存在的监控项原型。如果没有给出，则自动生成。 属性行为: - 如果监控项原型属于模板，则为支持 |
| valuemapid | ID | 关联的值映射ID。 属性行为: - 如果 数据类型设置为"浮点数t", "character", 或 "数字（无正负）"，则为支持- 继承对象时只读 |
| verify_host | integer | 是否验证连接的主机名是否与主机证书中的名称匹配。 可能的值： 0 - (默认) 不验证; 1 - 验证。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| verify_peer | integer | 是否验证主机的证书是否有效。 可能的值： 0 - (默认) 不验证; 1 - 验证。 属性行为: - 如果 type设置为"HTTP 代理"，则为支持- 继承对象时只读 |
| discover | integer | 监控项原型的发现状态。 可能的值： 0 - (默认) 将发现新项; 1 - 不会发现新项，并将现有项标记为丢失。 |
HTTP 头部
头部对象具有以下属性：
HTTP查询字段
查询字段对象定义了一个名称和值，用于指定URL参数。它具有以下属性：
监控项原型标签
监控项原型标签对象具有以下属性。
监控项原型预处理
监控项原型预处理对象具有以下属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| 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 - 丢弃未变化的； 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获取值。 属性行为: - 必需 |
| params | string | 预处理选项使用的附加参数。 多个参数用换行符(\n)分隔。 如果 type设置为"Check unsupported"，则参数遵循<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获取值"(30)时，params字段为必需。 |
| error_handler | integer | 预处理步骤失败时使用的操作类型。 可能的值： 0 - 错误消息由Zabbix服务器设置； 1 - 丢弃值； 2 - 设置自定义值； 3 - 设置自定义错误消息。 如果 type设置为"自定义乘数"(1)、"正则表达式"(5)、"布尔转十进制"(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获取值"(30)，则error_handler字段为必需。 |
| error_handler_params | string | 错误处理程序参数。 属性行为: - 如果 error_handler设置为"设置自定义值" 或 "设置自定义错误消息"，则为必需 |
以下是每种预处理类型支持的参数和错误处理程序：
| 预处理类型 | 名称 | 参数1 | 参数2 | 参数3 | 支持的错误处理程序 |
|---|---|---|---|---|---|
| 1 | 自定义乘数 | 数字1, 6 | 0, 1, 2, 3 | ||
| 2 | 右侧修剪 | 字符列表2 | |||
| 3 | 左侧修剪 | 字符列表2 | |||
| 4 | 修剪 | 字符列表2 | |||
| 5 | 正则表达式 | 模式3 | 输出2 | 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 | 路径4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | 路径4 | 0, 1, 2, 3 | ||
| 13 | 在范围内 | 最小值1, 6 | 最大值1, 6 | 0, 1, 2, 3 | |
| 14 | 匹配正则表达式 | 模式3 | 0, 1, 2, 3 | ||
| 15 | 不匹配正则表达式 | 模式3 | 0, 1, 2, 3 | ||
| 16 | 检查JSON中的错误 | 路径4 | 0, 1, 2, 3 | ||
| 17 | 检查XML中的错误 | 路径4 | 0, 1, 2, 3 | ||
| 18 | 使用正则表达式检查错误 | 模式3 | 输出2 | 0, 1, 2, 3 | |
| 19 | 丢弃未变化的 | ||||
| 20 | 丢弃未变化的带心跳 | 秒5, 6 | |||
| 21 | JavaScript | 脚本2 | |||
| 22 | Prometheus模式 | 模式6, 7 | value, label, function |
输出8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus转JSON | 模式6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV转JSON | 字符2 | 字符2 | 0,1 | 0, 1, 2, 3 |
| 25 | 替换 | 搜索字符串2 | 替换2 | ||
| 26 | 检查不支持 | 范围1 | 模式3, 6 | 1, 2, 3 | |
| 27 | XML转JSON | 0, 1, 2, 3 | |||
| 28 | SNMP walk值 | OID2 | 格式： 0 - 不变 1 - 从十六进制STRING转UTF-8 2 - 从十六进制STRING转MAC 3 - 从位字段转整数 |
0, 1, 2, 3 | |
| 29 | SNMP walk转JSON10 | 字段名称^2 | |||