Table of Contents
媒介类型对象
以下对象与 mediatype API 直接相关。
媒体类型
媒体类型对象具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| mediatypeid | ID | 媒体类型的ID。 属性行为: - 只读 - 更新操作所需 |
| name | 字符串 | 媒体类型的名称。 属性行为: - 创建操作所需 |
| type | 整数 | 媒体类型使用的传输方式。 可能的值： 0 - 邮件; 1 - 脚本; 2 - 短信; 4 - Webhook。 属性行为: - 创建操作所需 |
| exec_path | 字符串 | 位于AlertScriptsPath服务器配置参数指定目录中的脚本文件名称（例如，notification.sh）。 属性行为: - 如果 type设置为"脚本"则所需 |
| gsm_modem | 字符串 | GSM调制解调器的串行设备名称。 属性行为: - 如果 type设置为"短信"则所需 |
| passwd | 字符串 | 认证密码。 属性行为: - 如果 smtp_authentication设置为"普通密码"则支持 |
| provider | 整数 | 邮件提供商。 可能的值： 0 - (默认) 通用SMTP; 1 - Gmail; 2 - Gmail中继; 3 - Office365; 4 - Office365中继。 |
| smtp_email | 字符串 | 将从中发送通知的电子邮件地址。 属性行为: - 如果 type设置为"邮件"则所需 |
| smtp_helo | 字符串 | SMTP HELO。 属性行为: - 如果 type设置为"邮件"则支持 |
| smtp_server | 字符串 | SMTP服务器。 属性行为: - 如果 type设置为"邮件"则所需 |
| smtp_port | 整数 | 要连接的SMTP服务器端口。 默认：25。 属性行为: - 如果 type设置为"邮件"则支持 |
| smtp_security | 整数 | 要使用的SMTP连接安全级别。 可能的值： 0 - (默认) 无; 1 - STARTTLS; 2 - SSL/TLS。 属性行为: - 如果 type设置为"邮件"则支持 |
| smtp_verify_host | 整数 | SMTP的SSL验证主机。 可能的值： 0 - (默认) 否; 1 - 是。 属性行为: - 如果 smtp_security设置为"STARTTLS"或"SSL/TLS"则支持 |
| smtp_verify_peer | 整数 | SMTP的SSL验证对等体。 可能的值： 0 - (默认) 否; 1 - 是。 属性行为: - 如果 smtp_security设置为"STARTTLS"或"SSL/TLS"则支持 |
| smtp_authentication | 整数 | 要使用的SMTP认证方法。 可能的值： 0 - (默认) 无; 1 - 普通密码。 属性行为: - 如果 type设置为"邮件"则支持 |
| status | 整数 | 媒体类型是否启用。 可能的值： 0 - (默认) 启用; 1 - 禁用。 |
| username | 字符串 | 用户名。 属性行为: - 如果 smtp_authentication设置为"普通密码"则支持 |
| maxsessions | 整数 | 可以并行处理的警报最大数量。 如果 type设置为"短信"的可能值：1。如果 type设置为"邮件"，"脚本"或"Webhook"的可能值：0-100。默认：1。 |
| maxattempts | 整数 | 发送警报的最大尝试次数。 可能的值：1-100。 默认：3。 |
| attempt_interval | 字符串 | 重试尝试之间的间隔。 接受秒数和带后缀的时间单位。 可能的值：0-1h。 默认：10s。 |
| content_type (已废弃) |
整数 | 此参数已废弃，请改用message_format。消息格式。 可能的值： 0 - 纯文本; 1 - (默认) HTML。 属性行为: - 如果 type设置为"邮件"则支持 |
| message_format | 整数 | 消息格式。 可能的值： 0 - 纯文本; 1 - (默认) HTML。 属性行为: - 如果 type设置为"邮件"则支持 |
| script | 文本 | Webhook脚本体（JavaScript）。 属性行为: - 如果 type设置为"Webhook"则所需 |
| timeout | 字符串 | Webhook脚本超时。 接受秒数和带后缀的时间单位。 可能的值：1-60s。 默认：30s。 属性行为: - 如果 type设置为"Webhook"则支持 |
| process_tags | 整数 | 将Webhook脚本响应中的JSON属性值作为标签进行处理。这些标签将添加到任何现有问题标签中。 可能的值： 0 - (默认) 忽略Webhook脚本响应; 1 - 将Webhook脚本响应作为标签进行处理。 属性行为: - 如果 type设置为"Webhook"则支持 |
| show_event_menu | 整数 | 在事件菜单中包含一个条目，链接到自定义URL。同时也将urls属性添加到problem.get和event.get的输出中。可能的值： 0 - (默认) 不包含事件菜单条目或 urls属性;1 - 包含事件菜单条目和 urls属性。属性行为: - 如果 type设置为"Webhook"则支持 |
| event_menu_url | 字符串 | 在事件菜单条目中和由problem.get和event.get返回的urls属性中使用的URL。属性行为: - 如果 show_event_menu设置为"包含事件菜单条目和urls属性"则支持 |
| event_menu_name | 字符串 | 在事件菜单条目中和由problem.get和event.get返回的urls属性中使用的名称。属性行为: - 如果 show_event_menu设置为"包含事件菜单条目和urls属性"则支持 |
| parameters | 数组 | Webhook或脚本参数。 属性行为: - 如果 type设置为"Webhook"或"脚本"则支持 |
| description | 文本 | 媒体类型描述。 |
Webhook 参数
Webhook 参数具有以下属性。
脚本参数
脚本参数具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| sortorder | integer | 参数值传递给脚本作为命令行参数的顺序，从0开始作为第一个。 属性行为: - 必需 |
| value | string | 参数值，支持宏。 支持的宏在支持的宏页面中描述。 |
消息模板
消息模板对象定义了一个模板，该模板将作为操作动作发送通知的默认消息使用。它具有以下属性。