媒介类型 object

以下objects与mediatype API直接相关。

媒介类型

媒体类型 object 具有以下属性.

属性 数据类型 描述
mediatypeid ID 媒体类型的ID.

属性行为:
- 只读
- 必需 用于 update 操作
name string 媒体类型的名称.

属性行为:
- 必需 用于 create 操作
type integer 媒体类型使用的传输方式.

可能的值:
0 - 电子邮件;
1 - 脚本;
2 - 短信;
4 - Webhook.

属性行为:
- 必需 用于 create 操作
exec_path string 脚本 file 的名称 (例如, notification.sh), 该脚本位于 告警脚本路径 服务器配置参数指定的目录中.

属性行为:
- 必需 如果 type 设置为 "Script"
gsm_modem string GSM调制解调器的串行设备名称.

属性行为:
- 必需 如果 type 设置为 "SMS"
passwd string 认证密码.

属性行为:
- 支持 如果 smtp_authentication 设置为 "普通密码"
provider integer 电子邮件提供商.

可能的值:
0 - (默认) 通用SMTP;
1 - Gmail;
2 - Gmail中继;
3 - Office365;
4 - Office365中继.
smtp_email string 发送通知的电子邮件地址.

属性行为:
- 必需 如果 type 设置为 "Email"
smtp_helo string SMTP HELO.

属性行为:
- 支持 如果 type 设置为 "Email"
smtp_server string SMTP服务器.

属性行为:
- 必需 如果 type 设置为 "Email"
smtp_port integer 连接的SMTP服务器端口.

默认: 25.

属性行为:
- 支持 如果 type 设置为 "Email"
smtp_security integer 使用的SMTP连接安全级别.

可能的值:
0 - (默认) 无;
1 - STARTTLS;
2 - SSL/TLS.

属性行为:
- 支持 如果 type 设置为 "Email"
smtp_verify_host integer SMTP的SSL验证 主机.

可能的值:
0 - (默认) 否;
1 - 是.

属性行为:
- 支持 如果 smtp_security 设置为 "STARTTLS" 或 "SSL/TLS"
smtp_verify_peer integer SMTP的SSL验证对等端.

可能的值:
0 - (默认) 否;
1 - 是.

属性行为:
- 支持 如果 smtp_security 设置为 "STARTTLS" 或 "SSL/TLS"
smtp_authentication integer 使用的SMTP认证方法.

可能的值:
0 - (默认) 无;
1 - 普通密码;
2 - OAuth令牌.
OAuth认证不允许用于 Office365中继 电子邮件提供商.

属性行为:
- 支持 如果 type 设置为 "Email"
redirection_url string 用于重定向OAuth授权的Zabbix前端URL.

默认:
API 设置属性 url 的值, 部分 zabbix.php?action=oauth.authorize

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
client_id string 在OAuth授权服务器中注册的客户端标识符.

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
client_secret string 在OAuth授权服务器中注册的客户端密钥. 仅超级管理员类型的用户可以访问.

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
authorization_url string OAuth URL, 带参数, 用于 get 访问和刷新令牌.

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
token_url string OAuth URL, 用于将授权令牌交换为访问和刷新令牌.
此URL也由服务器用于刷新无效的访问令牌.

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
tokens_status integer 令牌状态的位掩码.

可能的值:
0 - (默认) 两个令牌都包含无效值
1 - 访问令牌包含有效值
2 - 刷新令牌包含有效值
3 - 两个令牌都包含有效值.

属性行为:
- 支持 如果 smtp_authentication 设置为 "OAuth令牌"
access_token string OAuth访问令牌值.

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
access_token_updated timestamp 服务器在刷新 refresh_token 或 API 令牌更改时对 access_token 的最后修改时间戳.

属性行为:
- 支持 如果 smtp_authentication 设置为 "OAuth令牌"
access_expires_in integer access_token 将过时并需要向 refresh_url 发出请求的时间(秒).
由 Zabbix server 在 access_token 刷新或 API 在令牌更改时设置.

时间戳通过添加 access_token_updated 的值计算.

属性行为:
- 支持 如果 smtp_authentication 设置为 "OAuth令牌"
refresh_token string OAuth刷新令牌值.

属性行为:
- 必需 如果 smtp_authentication 设置为 "OAuth令牌"
status integer 媒体类型是否启用.

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

属性行为:
- 支持 如果 smtp_authentication 设置为 "普通密码"
maxsessions integer 可以并行处理的最大警报数.

如果 type 设置为 "SMS" 时的可能值: 1.

如果 type 设置为 "Email", "Script", 或 "Webhook" 时的可能值: 0-100.

默认: 1.
maxattempts integer 发送警报的最大尝试次数.

可能的值: 1-100.

默认: 3.
attempt_interval string 重试尝试之间的间隔.
接受带后缀的秒和时间单位.

可能的值: 0-1h.

默认: 10s.
message_format integer 消息格式.

可能的值:
0 - 纯文本;
1 - (默认) HTML.

属性行为:
- 支持 如果 type 设置为 "Email"
script text Webhook脚本主体 (JavaScript).

属性行为:
- 必需 如果 type 设置为 "Webhook"
timeout string Webhook脚本超时.
接受带后缀的秒和时间单位.

可能的值: 1-60s.

默认: 30s.

属性行为:
- 支持 如果 type 设置为 "Webhook"
process_tags integer 将Webhook脚本响应中的JSON属性值作为标签处理. 这些标签会添加到任何现有问题标签中.

可能的值:
0 - (默认) 忽略webhook脚本响应;
1 - 将webhook脚本响应作为标签处理.

属性行为:
- 支持 如果 type 设置为 "Webhook"
show_event_menu integer event menu 中包含一个链接到自定义URL的条目. 同时将 urls 属性添加到 problem.getevent.get 的输出中.

可能的值:
0 - (默认) 不包含事件菜单条目或 urls 属性;
1 - 包含事件菜单条目和 urls 属性.

属性行为:
- 支持 如果 type 设置为 "Webhook"
event_menu_url string 用于 event menu 条目以及 problem.getevent.get 返回的 urls 属性中的URL.

属性行为:
- 支持 如果 show_event_menu 设置为 "包含事件菜单条目和 urls 属性"
event_menu_name string 用于 event menu 条目以及 problem.getevent.get 返回的 urls 属性中的名称.

属性行为:
- 支持 如果 show_event_menu 设置为 "包含事件菜单条目和 urls 属性"
parameters array Webhook脚本 参数.

属性行为:
- 支持 如果 type 设置为 "Webhook" 或 "Script"
description text 媒体类型描述.

Webhook参数

Webhook参数具有以下属性.

属性 数据类型 描述
name string 参数名称.

属性行为:
- 必填
value string 参数值,支持宏.
支持的宏在Supported macros页面有详细说明.

脚本参数

脚本参数具有以下属性。

属性 数据类型 描述
sortorder integer 参数值将作为命令行参数传递给脚本的顺序,从0开始作为第一个参数。

属性行为:
- 必填
value string 参数值,支持宏。
支持的宏在Supported macros页面有描述。

消息模板

消息模板 object 定义了将用作默认消息的模板,用于动作操作发送通知。它具有以下属性。

属性 数据类型 描述
eventsource integer 事件来源。

可能值:
0 - 触发器;
1 - 发现;
2 - 自动注册;
3 - 内部;
4 - 服务。

属性行为:
- 必填
recovery integer 操作模式。

可能值:
0 - 操作;
1 - 恢复操作;
2 - 更新操作。

属性行为:
- 必填
subject string 消息主题。
message string 消息文本。