监控项 object
以下 objects 直接与 item API 相关。
监控项
无法通过 Zabbix API 直接创建、更新或删除 Web 监控项。
监控项对象具有以下属性。
| Property | Type | Description |
|---|---|---|
| itemid | ID | 监控项的 ID。 Property behavior: - read-only - required for update operations |
| delay | string | 监控项的更新间隔。 接受秒数或带后缀的时间单位（例如 30s、1m、2h、1d），并且可选地接受一个或多个 自定义间隔，所有值用分号分隔。自定义间隔可以混合使用灵活间隔和计划间隔。 接受用户宏。如果使用，值必须是单个宏。不支持多个宏或宏与文本混合。灵活间隔可以写成两个由斜杠分隔的宏（例如 {$FLEX_INTERVAL}/{$FLEX_PERIOD}）。示例： 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Property behavior: - required if type is set to "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), or if type is set to "Zabbix agent (active)" (7) and key_ does not contain "mqtt.get" |
| hostid | ID | 监控项所属的主机或模板的 ID。 Property behavior: - constant - required for create operations |
| interfaceid | ID | 监控项的主机接口 ID。 Property behavior: - required if item belongs to host and type is set to "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap", or "SNMP agent"- supported if item belongs to host and type is set to "Simple check", "External check", "SSH agent", "TELNET agent", or "HTTP agent"- read-only for discovered objects |
| key_ | string | 监控项键值。 Property behavior: - required for create operations - read-only for inherited objects or discovered objects |
| name | string | 监控项名称。 支持用户宏。 Property behavior: - required for create operations - read-only for inherited objects or discovered objects |
| name_resolved | string | 已解析用户宏后的监控项名称。 Property behavior: - read-only |
| type | integer | 监控项类型。 可能的值： 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 9 - Web item; 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser。 Property behavior: - required for create operations - read-only for inherited objects or discovered objects |
| url | string | URL 字符串。 支持用户宏、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}。 Property behavior: - required if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| value_type | integer | 监控项的信息类型。 可能的值： 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary。 Property behavior: - required for create operations - read-only for inherited objects or discovered objects |
| allow_traps | integer | 允许像 trapper 监控项一样填充值。 0 - (default) 不允许接收传入数据； 1 - 允许接收传入数据。 Property behavior: - supported if type is set to "HTTP agent"- read-only for discovered objects |
| authtype | integer | 认证方式。 如果 type 设置为 "SSH agent"，可能的值：0 - (default) password; 1 - public key。 如果 type 设置为 "HTTP agent"，可能的值：0 - (default) none; 1 - basic; 2 - NTLM; 3 - Kerberos; 4 - Digest。 Property behavior: - supported if type is set to "SSH agent" or "HTTP agent"- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects |
| description | string | 监控项描述。 Property behavior: - read-only for discovered objects |
| error | string | 如果更新监控项值时出现问题，则显示错误文本。 Property behavior: - read-only |
| flags | integer | 监控项的来源。 可能的值： 0 - 普通监控项； 4 - 发现的监控项。 Property behavior: - read-only |
| follow_redirects | integer | 轮询数据时是否跟随响应重定向。 可能的值： 0 - 不跟随重定向； 1 - (default) 跟随重定向。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| headers | array | 执行 HTTP 请求时发送的 headers 数组。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| history | string | 历史数据的保存时长时间单位。 也接受用户宏。 默认值：31d。 Property behavior: - read-only for discovered objects |
| http_proxy | string | HTTP(S) proxy 连接字符串。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| inventory_link | integer | 由该监控项填充的主机资产清单字段 ID。 有关支持的主机资产清单字段及其 ID 列表，请参阅 主机资产清单页面。 默认值：0。 Property behavior: - supported if value_type is set to "numeric float", "character", "numeric unsigned", or "text"- read-only for discovered objects |
| ipmi_sensor | string | IPMI 传感器。 Property behavior: - required if type is set to "IPMI agent" and key_ is not set to "ipmi.get"- supported if type is set to "IPMI agent"- read-only for inherited objects or discovered objects |
| jmx_endpoint | string | JMX agent 自定义连接字符串。 默认值：service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Property behavior: - supported if type is set to "JMX agent"- read-only for discovered objects |
| lastclock | timestamp | 监控项值最后更新时间。 默认情况下，仅显示最近 24 小时内的值。您可以通过在 Administration → General 菜单部分更改 Max history display period 参数的值来延长此时间范围。 Property behavior: - read-only |
| lastns | integer | 监控项值最后更新时间的纳秒部分。 默认情况下，仅显示最近 24 小时内的值。您可以通过在 Administration → General 菜单部分更改 Max history display period 参数的值来延长此时间范围。 Property behavior: - read-only |
| lastvalue | string | 监控项的最新值。 默认情况下，仅显示最近 24 小时内的值。您可以通过在 Administration → General 菜单部分更改 Max history display period 参数的值来延长此时间范围。 Property behavior: - read-only |
| logtimefmt | string | 日志条目中的时间格式。 Property behavior: - supported if value_type is set to "log"- read-only for inherited objects or discovered objects |
| master_itemid | ID | 主监控项的 ID。 允许最多递归 3 层依赖监控项，且依赖监控项最大数量为 29999。 Property behavior: - required if type is set to "Dependent item"- read-only for inherited objects or discovered objects |
| output_format | integer | 是否应将响应转换为 JSON。 0 - (default) 原样存储； 1 - 转换为 JSON。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| params | string | 根据监控项类型而定的附加参数： - SSH agent 和 TELNET agent 监控项的执行脚本； - database monitor 监控项的 SQL 查询； - calculated 监控项的公式； - script 和 browser 监控项的脚本。 Property behavior: - required if type is set to "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script", or "Browser"- read-only for inherited objects (if type is set to "Script" or "Browser") or discovered objects |
| parameters | object/array | 如果 type 设置为 "Script" 或 "Browser"，则为附加参数。由具有 name 和 value 属性的对象数组组成，其中 name 必须唯一。Property behavior: - supported if type is set to "Script" or "Browser"- read-only for inherited objects or discovered objects |
| password | string | 认证密码。 Property behavior: - required if type is set to "JMX agent" and username is set- supported if type is set to "Simple check", "SSH agent", "TELNET agent", "Database monitor", or "HTTP agent"- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects |
| post_type | integer | 存储在 posts 属性中的请求体数据类型。可能的值： 0 - (default) 原始数据； 2 - JSON 数据； 3 - XML 数据。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| posts | string | HTTP(S) 请求体数据。 Property behavior: - required if type is set to "HTTP agent" and post_type is set to "JSON data" or "XML data"- supported if type is set to "HTTP agent" and post_type is set to "Raw data"- read-only for inherited objects or discovered objects |
| prevvalue | string | 监控项的上一个值。 默认情况下，仅显示最近 24 小时内的值。您可以通过在 Administration → General 菜单部分更改 Max history display period 参数的值来延长此时间范围。 Property behavior: - read-only |
| privatekey | string | 私钥文件名。 Property behavior: - required if type is set to "SSH agent" and authtype is set to "public key"- read-only for discovered objects |
| publickey | string | 公钥文件名。 Property behavior: - required if type is set to "SSH agent" and authtype is set to "public key"- read-only for discovered objects |
| query_fields | array | 执行 HTTP 请求时发送的 query fields 数组。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| request_method | integer | 请求方法类型。 可能的值： 0 - (default) GET; 1 - POST; 2 - PUT; 3 - HEAD。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| retrieve_mode | integer | 应存储响应的哪一部分。 如果 request_method 设置为 "GET"、"POST" 或 "PUT"，可能的值：0 - (default) Body; 1 - Headers; 2 - 同时存储 body 和 headers。 如果 request_method 设置为 "HEAD"，可能的值：1 - Headers。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| snmp_oid | string | SNMP OID。 Property behavior: - required if type is set to "SNMP agent"- read-only for inherited objects or discovered objects |
| ssl_cert_file | string | 公用 SSL 密钥文件路径。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| ssl_key_file | string | 私有 SSL 密钥文件路径。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| ssl_key_password | string | SSL 密钥文件密码。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| state | integer | 监控项状态。 可能的值： 0 - (default) 正常； 1 - 不受支持。 Property behavior: - read-only |
| status | integer | 监控项状态。 可能的值： 0 - (default) 启用的监控项； 1 - 禁用的监控项。 |
| status_codes | string | 所需 HTTP 状态码范围，以逗号分隔。 也支持将用户宏作为逗号分隔列表的一部分。 示例：200,200-{$M},{$M},200-400 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| templateid | ID | 父模板监控项的 ID。 提示：使用 hostid 属性指定该监控项所属的模板。Property behavior: - read-only |
| timeout | string | 监控项数据轮询请求超时时间。 接受秒数或带后缀的时间单位（例如 30s、1m）。也接受用户宏。 取值范围：1-600s。 默认值："" - 使用 proxy/全局设置。 Property behavior: - supported if type is set to "Zabbix agent" (0), "Simple check" (3) and key_ does not start with "vmware." and "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) and snmp_oid starts with "walk[" or "get[", "Script" (21), "Browser" (22)- read-only for inherited and discovered objects |
| trapper_hosts | string | 允许的主机。 Property behavior: - readonly for discovered objects - supported if type is set to "Zabbix trapper", or if type is set to "HTTP agent" and allow_traps is set to "Allow to accept incoming data" |
| trends | string | 趋势数据的保存时长时间单位。 也接受用户宏。 默认值：365d。 Property behavior: - supported if value_type is set to "numeric float" or "numeric unsigned"- read-only for discovered objects |
| units | string | 值单位。 Property behavior: - supported if value_type is set to "numeric float" or "numeric unsigned"- read-only for inherited objects or discovered objects |
| username | string | 认证用户名。 Property behavior: - required if type is set to "SSH agent", "TELNET agent", or if type is set to "JMX agent" and password is set- supported if type is set to "Simple check", "Database monitor", or "HTTP agent"- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects |
| uuid | string | 通用唯一标识符，用于将导入的监控项链接到已存在的监控项。如果未提供，则自动生成。 Property behavior: - supported if the item belongs to a template |
| valuemapid | ID | 关联值映射的 ID。 Property behavior: - supported if value_type is set to "numeric float", "character", or "numeric unsigned"- read-only for inherited objects or discovered objects |
| verify_host | integer | 是否验证连接的主机名与主机证书中的名称一致。 可能的值： 0 - (default) 不验证； 1 - 验证。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
| verify_peer | integer | 是否验证主机证书是否可信。 可能的值： 0 - (default) 不验证； 1 - 验证。 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects or discovered objects |
HTTP 头
header 对象具有以下属性：
| Property | Type | Description |
|---|---|---|
| name | string | HTTP 头名称。 Property behavior: - required |
| value | string | 头值。 Property behavior: - required |
HTTP 查询字段
查询字段对象定义了一个名称和值，用于指定 URL 参数。 它具有以下属性：
| Property | Type | Description |
|---|---|---|
| name | string | 参数名称。 Property behavior: - required |
| value | string | 参数值。 Property behavior: - required |
监控项标签
监控项标签对象具有以下属性。
| Property | Type | Description |
|---|---|---|
| tag | string | 监控项标签名称。 Property behavior: - required |
| value | string | 监控项标签值。 |
监控项预处理
监控项预处理对象具有以下属性。
| Property | Type | Description |
|---|---|---|
| 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 获取值。 Property behavior: - required |
| params | string | 预处理选项使用的附加参数。 多个参数之间使用换行符 (\n) 分隔。 如果 type 设置为 "Check unsupported"，参数采用 <scope>[\n<pattern>] 语法，其中 pattern 为正则表达式，scope 为以下之一：-1 - 匹配任意错误； \ 0 - 检查错误消息是否匹配 pattern； \ 1 - 检查错误消息是否不匹配 pattern。 Property behavior: - 当 type 设置为 "Custom multiplier" (1)、"Right trim" (2)、"Left trim" (3)、"Trim" (4)、"Regular expression" (5)、"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)、"Discard unchanged with heartbeat" (20)、"JavaScript" (21)、"Prometheus pattern" (22)、"Prometheus to JSON" (23)、"CSV to JSON" (24)、"Replace" (25)、Check unsupported (26)、"SNMP walk value" (28)、"SNMP walk to JSON" (29) 或 "SNMP get value" (30) 时，required |
| error_handler | integer | 预处理步骤失败时使用的动作类型。 可能的值： 0 - 由 Zabbix 服务器设置错误消息； 1 - 丢弃值； 2 - 设置自定义值； 3 - 设置自定义错误消息。 如果 type 设置为 "Check unsupported"，可能的值为：1 - 丢弃值； 2 - 设置自定义值； 3 - 设置自定义错误消息。 Property behavior: - 当 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) 时，required |
| error_handler_params | string | 错误处理程序参数。 Property behavior: - 当 error_handler 设置为 "Set custom value" 或 "Set custom error message" 时，required |
以下参数和错误处理程序适用于每种预处理类型。
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 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 浮点数（整数会隐式转换为浮点值）
2 字符串
3 正则表达式
4 JSONPath 或 XML XPath
5 正整数（支持时间后缀，例如 30s、1m、2h、1d）
6 用户宏
7 采用以下语法的 Prometheus 模式：<metric name>{<label name>="<label value>", ...} == <value>。Prometheus 模式的每个组成部分（指标、标签名、标签值和指标值）都可以是用户宏。
8 采用以下语法的 Prometheus 输出：<label name>（如果第二个参数选择了 label，则可以是用户宏）。
9 以下聚合函数之一：sum、min、max、avg、count，如果第二个参数选择了 function。
10 支持多个以换行符分隔的 "Field name,OID prefix,Format records" 记录。