消息推送:按 action 选择功能
这个请求地址通过 action 区分具体功能。下方列出每个 action 的参数、约束和调用示例。
POST
https://your-panel.example.com:8888/pushRequest bodyX-WWW-FORM-URLENCODEDrequired
One of the following:
- get_modules_list
- get_task_template
Returns
default
响应因 action 而异,见下方各 action 的详细说明。
各操作详细说明
get_modules_listaction=get_modules_list获取消息推送模块列表(邮件、钉钉、飞书、微信等)
获取可用的消息推送模块列表。
- 路由:
POST /push - action:
get_modules_list
输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| action | 是 | String | 固定值 get_modules_list |
输出参数
返回各推送模块配置,key 为模块名。
| 模块名 | 说明 |
|---|---|
| panel_push | 面板基础提醒 |
| 邮箱推送 | |
| dingding | 钉钉 |
| feishu | 飞书 |
| weixin | 微信 |
| sms | 短信 |
示例
{
"panel_push": {"name": "panel_push", "title": "面板基础提醒", "version": "1.2"},
"mail": {"name": "mail", "title": "邮箱", "setup": true}
}
get_push_list获取推送规则列表(流量告警、站点告警等)
get_push_list / get_push_logs
查看推送规则和推送日志。
- 路由:
POST /push
get_push_list
获取当前配置的推送规则列表。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| action | 是 | String | get_push_list |
| p | 否 | Integer | 页码 |
| limit | 否 | Integer | 每页数量 |
get_push_logs
获取推送日志记录。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| action | 是 | String | get_push_logs |
| p | 否 | Integer | 页码 |
| limit | 否 | Integer | 每页数量 |
相关接口
- get_modules_list — 推送模块列表
输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | Boolean | 请求结果,true 表示成功 |
| msg | String | 提示信息 |
get_task_templateaction=get_task_template获取消息推送任务模板列表
获取消息推送的告警任务模板列表。
- 路由:
POST /push - action:
get_task_template
输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| action | 是 | String | 固定值 get_task_template |
输出
返回数组,每项为一个告警模板组,包含 title 和 template 字段。
[{"title": "常用告警设置", "template": []}]