2022 Zabbix中国峰会
2022 Zabbix中国峰会

> 媒介类型对象

以下对象与 mediatype API 直接相关。

媒介类型

媒介类型对象具有以下属性。

属性 类型 描述
mediatypeid string (只读) 媒介类型ID。
名称
(必需)
string 媒介类型名称。
type
(必需)
integer 媒介类型使用的传输方式。

可用值:
0 - 电子邮件;
1 - 脚本;
2 - SMS;
4 - Webhook。
exec_path string 对于脚本媒介类型,exec_path 包含执行脚本的名称。

对于脚本媒介类型是必需的。
gsm_modem string GSM 调制解调器的串行设备名称。

对于 SMS 媒介类型是必需的。
passwd string 身份验证密码。

用于电子邮件媒介类型。
smtp_email string 用于发送通知的电子邮件地址。

电子邮件媒介类型所必需的。
smtp_helo string SMTP HELO。

对于电子邮件媒介类型是必需的。
smtp_server string SMTP 服务器。

对于电子邮件媒介类型是必需的。
smtp_port integer 要连接的 SMTP 服务器端口。
smtp_security integer 要使用的 SMTP 连接安全级别。

可用值:
0 - 无;
1 - STARTTLS;
2 - SSL/TLS。
smtp_verify_host integer 用于 SMTP 的 SSL 验证主机。

可用值:
0 - 否;
1 - 是。
smtp_verify_peer integer 用于 SMTP 的 SSL 验证对等点。

可用值:
0 - 否;
1 - 是。
smtp_authentication integer 要使用的 SMTP 身份验证方法。

可用值:
0 - 无;
1 - 普通密码。
status integer 媒介类型是否启用。

可用值:
0 - (默认)启用;
1 - 禁用。
username string 用户名。

用于电子邮件媒介类型。
exec_params string 脚本参数。

每个参数都以新的换行符结尾。
maxsessions integer 可以并行处理的最大警报数。

SMS 的可用值:
1 - (默认)

其他媒介类型的可用值:
0-100
maxattempts integer 尝试发送警报的最大次数。

可用值:
1-100

默认值:
3
attempt_interval string 重试尝试之间的间隔。接受秒和带后缀的时间单位。
<br可用值:
0-1h

默认值:
10s
content_type integer 消息格式。

可用值:
0 - 纯文本;
1 - (默认) html。
script string 媒介类型 webhook 脚本 javascript 正文。
timeout string 媒介类型 webhook 脚本超时。接受秒和带后缀的时间单位。

可用值:
1-60s

默认值:
30s
process_tags integer 定义 webhook 脚本响应是否应被解释为标签,并且这些标签应添加到相关事件中。

可用值:
0 - (默认) 忽略 webhook 脚本响应.
1 - 将 webhook 脚本响应作为标签处理。
show_event_menu integer problem.getevent.get 属性 urls 中显示媒介类型条目。

可用值:
0 - (默认) 不添加为 urls 条目。
1 - 将媒介类型添加到 urls 属性。
event_menu_url string problem.getevent.geturls 属性中定义媒介类型条目的 url 属性。
event_menu_name string problem.getevent.geturls 属性中定义媒介类型条目的 name 属性。
parameters array webhook 输入参数的数组。
description string 媒介类型描述。

注意,对于某些方法(更新、删除),必需/可选参数组合是不同的。

Webhook 参数

调用 webhook 脚本时传递的参数,具有以下属性。

属性 类型 描述
name
(必需)
string 参数名称。
value string 参数值,支持宏。
支持的宏在支持的宏页面中描述。

消息模板

消息模板对象定义了一个模板,该模板将用作动作操作发送通知的默认消息。具有以下属性。

属性 类型 描述
eventsource
(必需)
integer 事件源。

可用值:
0 - 触发器;
1 - 自动发现;
2 - 自动注册;
3 - 采集器;
4 - 服务端。
recovery
(必需)
integer 操作模式。

可用值:
0 - 自动操作;
1 - 恢复操作;
2 - 更新操作。
subject string 消息主题。
message string 消息文本。