> 媒介类型 object

以下objects与mediatype API直接相关。

媒介类型

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

属性 数据类型 描述
mediatypeid string (只读) 媒体类型的ID。
name
(required)
string 媒体类型的名称。
type
(required)
integer 媒体类型使用的传输方式。

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

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

短信媒体类型必需。
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 可以并行处理的最大告警数量。

短信的可能值:
1 - (默认)

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

可能的值:
1-100

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

可能的值:
0-1h

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

可能的值:
0 - 纯文本;
1 - (默认) HTML。
script text 媒体类型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-参数的array。
description text 媒体类型描述。

请注意,某些方法(更新、删除)所需/可选参数的组合有所不同。

Webhook 参数

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

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

消息模板

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

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

可能的值:
0 - 触发器;
1 - 自动发现;
2 - 自动注册;
3 - 内部事件;
4 - 服务。
recovery
(required)
integer 操作模式。

可能的值:
0 - 常规操作;
1 - 恢复操作;
2 - 更新操作。
subject string 消息主题。
message string 消息正文。