Documentation
Table of Contents
媒介类型 object
以下objects与mediatypeAPI直接相关。
媒介类型
媒介类型 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| mediatypeid | ID | 媒介类型的ID。 属性行为: - 只读 - 对于 update 操作是必需的 |
| name | string | 媒介类型的名称。 属性行为: - 对于 create 操作是必需的 |
| type | integer | 媒介类型使用的传输方式。 可能的值： 0 - 电子邮件； 1 - 脚本； 2 - 短信； 4 - Webhook。 属性行为: - 对于 create 操作是必需的 |
| exec_path | string | 脚本 file 的名称（例如，notification.sh），该脚本位于服务器配置参数 告警脚本路径 指定的目录中。 属性行为: - 如果 type 设置为“脚本”则是必需的 |
| gsm_modem | string | GSM调制解调器的串行设备名称。 属性行为: - 如果 type 设置为“短信”则是必需的 |
| passwd | string | 认证密码。 属性行为: - 如果 smtp_authentication 设置为“普通密码”则支持 |
| provider | integer | 电子邮件提供商。 可能的值： 0 - (默认) 通用SMTP； 1 - Gmail； 2 - Gmail中继； 3 - Office365； 4 - Office365中继。 |
| smtp_email | string | 发送通知的电子邮件地址。 属性行为: - 如果 type 设置为“电子邮件”则是必需的 |
| smtp_helo | string | SMTP HELO。 属性行为: - 如果 type 设置为“电子邮件”则支持 |
| smtp_server | string | SMTP服务器。 属性行为: - 如果 type 设置为“电子邮件”则是必需的 |
| smtp_port | integer | 要连接的SMTP服务器端口。 默认值：25。 属性行为: - 如果 type 设置为“电子邮件”则支持 |
| smtp_security | integer | 要使用的SMTP连接安全级别。 可能的值： 0 - (默认) 无； 1 - STARTTLS； 2 - SSL/TLS。 属性行为: - 如果 type 设置为“电子邮件”则支持 |
| 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 - 普通密码。 属性行为: - 如果 type 设置为“电子邮件”则支持 |
| status | integer | 媒介类型是否启用。 可能的值： 0 - (默认) 已启用； 1 - 已禁用。 |
| username | string | 用户名。 属性行为: - 如果 smtp_authentication 设置为“普通密码”则支持 |
| maxsessions | integer | 可以并行处理的警报最大数量。 如果 type 设置为“短信”，可能的值：1。如果 type 设置为“电子邮件”、“脚本”或“Webhook”，可能的值：0-100。默认值：1。 |
| maxattempts | integer | 发送警报的最大尝试次数。 可能的值：1-100。 默认值：3。 |
| attempt_interval | string | 重试尝试之间的间隔。 接受秒和带后缀的时间单位。 可能的值：0-1h。 默认值：10s。 |
| content_type (deprecated) |
integer | 此参数已弃用，请改用 message_format。消息格式。 可能的值： 0 - 纯文本； 1 - (默认) HTML。 属性行为: - 如果 type 设置为“电子邮件”则支持 |
| message_format | integer | 消息格式。 可能的值： 0 - 纯文本； 1 - (默认) HTML。 属性行为: - 如果 type 设置为“电子邮件”则支持 |
| 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.get 和 event.get 的输出中。可能的值： 0 - (默认) 不包含事件菜单条目或 urls 属性；1 - 包含事件菜单条目和 urls 属性。属性行为: - 如果 type 设置为“Webhook”则支持 |
| event_menu_url | string | 在 event menu 条目中以及在 problem.get 和 event.get 返回的 urls 属性中使用的URL。属性行为: - 如果 show_event_menu 设置为“包含事件菜单条目和 urls 属性”则支持 |
| event_menu_name | string | 在 event menu 条目中以及在 problem.get 和 event.get 返回的 urls 属性中使用的名称。属性行为: - 如果 show_event_menu 设置为“包含事件菜单条目和 urls 属性”则支持 |
| parameters | array | Webhook 或 脚本 参数。 属性行为: - 如果 type 设置为“Webhook”或“脚本”则支持 |
| description | text | 媒介类型描述。 |
Webhook参数
Webhook 参数具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| name | string | 参数名称。 属性行为： - 必填 |
| value | string | 参数值，支持宏。 支持的宏在 Supported macros 页面中描述。 |
脚本参数
脚本参数具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| sortorder | integer | 参数值将按照此顺序作为命令行参数传递给脚本，第一个参数为 0。 属性行为： - 必填 |
| value | string | 参数值，支持宏。 支持的宏在 Supported macros 页面中有详细描述。 |
消息模板
消息模板 object 定义了一个模板，该模板将用作操作操作发送通知时的默认消息。它具有以下属性。