Documentation
Table of Contents
媒介类型对象
以下对象与 mediatype API 直接相关。
媒体类型
媒体类型对象具有以下属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| mediatypeid | ID | 媒体类型的ID。 属性行为： - 只读 - 更新操作所需 |
| name | string | 媒体类型的名称。 属性行为： - 创建操作所需 |
| type | integer | 媒体类型使用的传输方式。 可能的值： 0 - 电子邮件； 1 - 脚本； 2 - 短信； 4 - Webhook。 属性行为： - 创建操作需要 |
| exec_path | string | 对于脚本媒体类型，exec_path 包含执行脚本的名称。属性行为： - 如果 type 设置为“脚本”，则需要 |
| gsm_modem | string | GSM 调制解调器的串行设备名称。 属性行为: - 如果 type 设置为 "SMS"，则为 必需 |
| passwd | string | 身份验证密码。 属性行为： - 如果 type 设置为 "Email"，则为 支持 |
| smtp_email | string | 发送通知的电子邮件地址。 属性行为: - 如果 type 设置为 "Email"，则为 必需 |
| smtp_helo | string | SMTP HELO。 属性行为： - 如果 type 设置为“Email”，则 必填 |
| smtp_server | string | SMTP 服务器。 属性行为： - 如果 type 设置为“Email”，则 必填 |
| smtp_port | integer | 要连接的 SMTP 服务器端口。 |
| smtp_security | integer | 要使用的 SMTP 连接安全级别。 可能的值： 0 - 无； 1 - STARTTLS； 2 - SSL/TLS。 |
| smtp_verify_host | 整数 | SMTP 的 SSL 验证主机。 可能的值： 0 - 否； 1 - 是。 |
| smtp_verify_peer | 整数 | SMTP 的 SSL 验证对等端。 可能的值： 0 - 否； 1 - 是。 |
| smtp_authentication | 整数 | 要使用的 SMTP 身份验证方法。 可能的值： 0 - 无； 1 - 普通密码。 |
| status | 整数 | 媒体类型是否已启用。 可能的值： 0 - （默认） 已启用； 1 - 已禁用。 |
| username | string | 用户名。 属性行为： - 如果 type 设置为“Email”，则 支持 |
| maxsessions | integer | 可并行处理的最大警报数。 如果 type 设置为“SMS”，则可能的值：(默认) 1。如果 type 设置为“Email”、“Script”或“Webhook”，则可能的值：0-100。 |
| maxattempts | integer | 发送警报的最大尝试次数。 可能的值：1-100。 默认值：3。 |
| attempt_interval | string | 重试间隔。接受带后缀的秒和时间单位。 可能的值：0-1h。 默认值：10s。 |
| content_type (已弃用) |
integer | 此参数已弃用，请改用 message_format。消息格式。 可能的值： 0 - 纯文本； 1 - (默认) html。 |
| message_format | integer | 消息格式。 可能的值： 0 - 纯文本； 1 - (默认) html。 |
| script | string | 媒体类型 webhook 脚本 javascript 正文。 |
| timeout | string | 媒体类型 webhook 脚本超时。 接受带后缀的秒和时间单位。 可能的值：1-60 秒。 默认值：30 秒。 |
| process_tags | integer | 定义是否应将 webhook 脚本响应解释为标签，并应将这些标签添加到相关事件中。 可能的值： 0 - (默认) 忽略 webhook 脚本响应； 1 - 将 webhook 脚本响应作为标签处理。 |
| show_event_menu | integer | 在 problem.get 和 event.get 属性 urls 中显示媒体类型条目。可能的值： 0 - (默认) 不添加 urls 条目；1 - 将媒体类型添加到 urls 属性。 |
| event_menu_url | string | 在 problem.get 和 event.get 的 urls 属性中定义媒体类型条目的 url 属性。 |
| event_menu_name | string | 在 problem.get 和 event.get 的 urls 属性中定义媒体类型条目的 name 属性。 |
| parameters | array | webhook 或 script 输入参数的数组。 |
| description | string | 媒体类型描述。 |
Webhook 参数
调用 webhook 脚本时传递的参数，具有以下属性。
脚本参数
调用脚本时传递给脚本的参数具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| sortorder | integer | 参数作为命令行参数传递给脚本的顺序，从 0 作为第一个参数开始。 属性行为: - 必需 |
| value | string | 参数值，支持宏。 支持的宏在支持的宏 页面作了详细描述。 |
消息模板
消息模板对象定义了一个模板，该模板将用作 用于发送通知的操作操作的默认消息。它有 以下属性。