媒介类型 object

以下objects与mediatypeAPI直接相关。

媒体类型

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

Property Type Description
mediatypeid ID 媒体类型的 ID。

Property behavior:
- 只读
- 更新操作时为 必需
name string 媒体类型名称。

Property behavior:
- 创建操作时为 必需
type integer 媒体类型使用的传输方式。

可能的值：
0 - Email；
1 - Script；
2 - SMS；
4 - Webhook。

Property behavior:
- 创建操作时为 必需
exec_path string 脚本文件名（例如 notification.sh），位于 AlertScriptsPath 服务器配置参数指定的目录中。

Property behavior:
- 当 type 设置为 "Script" 时为 必需
gsm_modem string GSM 调制解调器的串行设备名称。

Property behavior:
- 当 type 设置为 "SMS" 时为 必需
passwd string 认证密码。

Property behavior:
- 当 smtp_authentication 设置为 "Normal password" 时为 支持
provider integer Email 提供商。

可能的值：
0 - (默认) Generic SMTP；
1 - Gmail；
2 - Gmail relay；
3 - Office365；
4 - Office365 relay。
smtp_email string 发送通知所使用的电子邮件地址。

Property behavior:
- 当 type 设置为 "Email" 时为 必需
smtp_helo string SMTP HELO。

Property behavior:
- 当 type 设置为 "Email" 时为 支持
smtp_server string SMTP 服务器。

Property behavior:
- 当 type 设置为 "Email" 时为 必需
smtp_port integer 要连接的 SMTP 服务器端口。

默认值：25。

Property behavior:
- 当 type 设置为 "Email" 时为 支持
smtp_security integer 要使用的 SMTP 连接安全级别。

可能的值：
0 - (默认) 无；
1 - STARTTLS；
2 - SSL/TLS。

Property behavior:
- 当 type 设置为 "Email" 时为 支持
smtp_verify_host integer SMTP 的 SSL 主机验证。

可能的值：
0 - (默认) 否；
1 - 是。

Property behavior:
- 当 smtp_security 设置为 "STARTTLS" 或 "SSL/TLS" 时为 支持
smtp_verify_peer integer SMTP 的 SSL 对端验证。

可能的值：
0 - (默认) 否；
1 - 是。

Property behavior:
- 当 smtp_security 设置为 "STARTTLS" 或 "SSL/TLS" 时为 支持
smtp_authentication integer 要使用的 SMTP 认证方式。

可能的值：
0 - (默认) 无；
1 - Normal password。

Property behavior:
- 当 type 设置为 "Email" 时为 支持
status integer 媒体类型是否启用。

可能的值：
0 - (默认) 已启用；
1 - 已禁用。
username string 用户名。

Property behavior:
- 当 smtp_authentication 设置为 "Normal password" 时为 支持
maxsessions integer 可并行处理的告警最大数量。

当 type 设置为 "SMS" 时的可能值：1。

当 type 设置为 "Email"、"Script" 或 "Webhook" 时的可能值：0-100。

默认值：1。
maxattempts integer 发送告警的最大尝试次数。

可能的值：1-100。

默认值：3。
attempt_interval string 重试尝试之间的间隔。
接受带后缀的秒数和时间单位。

可能的值：0-1h。

默认值：10s。
content_type
(deprecated)		 integer 此参数已弃用，请改用 message_format。
消息格式。

可能的值：
0 - 纯文本；
1 - (默认) HTML。

Property behavior:
- 当 type 设置为 "Email" 时为 支持
message_format integer 消息格式。

可能的值：
0 - 纯文本；
1 - (默认) HTML。

Property behavior:
- 当 type 设置为 "Email" 时为 支持
script text Webhook 脚本主体（JavaScript）。

Property behavior:
- 当 type 设置为 "Webhook" 时为 必需
timeout string Webhook 脚本超时时间。
接受带后缀的秒数和时间单位。

可能的值：1-60s。

默认值：30s。

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

可能的值：
0 - (默认) 忽略 Webhook 脚本响应；
1 - 将 Webhook 脚本响应作为标签处理。

Property behavior:
- 当 type 设置为 "Webhook" 时为 支持
show_event_menu integer 在 event menu 中包含一个链接到自定义 URL 的条目。还会将 urls 属性添加到 problem.get 和 event.get 的输出中。

可能的值：
0 - (默认) 不包含 event menu 条目或 urls 属性；
1 - 包含 event menu 条目和 urls 属性。

Property behavior:
- 当 type 设置为 "Webhook" 时为 支持
event_menu_url string 用于 event menu 条目以及 problem.get 和 event.get 返回的 urls 属性中的 URL。

Property behavior:
- 当 show_event_menu 设置为 "Include event menu entry and urls property" 时为 支持
event_menu_name string 用于 event menu 条目以及 problem.get 和 event.get 返回的 urls 属性中的名称。

Property behavior:
- 当 show_event_menu 设置为 "Include event menu entry and urls property" 时为 支持
parameters array Webhook 或 script 参数。

Property behavior:
- 当 type 设置为 "Webhook" 或 "Script" 时为 支持
description text 媒体类型描述。

webhook 参数

webhook 参数具有以下属性。

Property Type Description
name string 参数名称。

属性行为:
- required
value string 参数值，支持宏。
支持的宏请参见 Supported macros 页面。

脚本参数

脚本参数具有以下属性。

Property Type Description
sortorder integer 参数值作为命令行参数传递给脚本的顺序，从 0 开始，0 为第一个。

Property behavior:
- required
value string 参数值，支持宏。
支持的宏请参见 Supported macros 页面。

消息模板

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

Property Type Description
eventsource integer 事件来源。

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

Property behavior:
- required
recovery integer 操作模式。

可能的值：
0 - 操作；
1 - 恢复操作；
2 - 更新操作。

Property behavior:
- required
subject string 消息主题。
message string 消息文本。