智能顾问 订阅报告-WebHook 接收方式

Webhook(网络钩子)是一种基于 HTTP 的消息推送机制。当某个事件发生时,系统会主动向你预先配置的 URL 地址发送一条 HTTP 请求,将事件相关的数据推送过去。

相关产品
智能顾问 产品页,含版本规格、价格与购买入口。

一、什么是 Webhook 接收方式

在报告订阅中,Webhook 接收方式指的是:当报告生成后,系统会在你指定的时间自动将报告数据及相关文件链接以 HTTP 请求的形式推送至你指定的接口地址,无需依赖邮件系统,即可实现报告的自动化接收与处理。你可以在报告订阅中选择 Webhook 接收方式,并填写自定义服务端接口或支持 Webhook 的第三方平台地址,用于接收报告推送。

二、适用场景

·自定义系统 / 内部业务系统:用于数据归档、流程触发。

·第三方协作平台:用于消息分发与团队通知。

·数据处理服务:用于报告内容的二次加工与分析。

注意:说明:

注意:支持企业微信群消息推送(Webhook)。

三、新建报告订阅

这篇以订阅中心页面创建为例,具体操作步骤如下:

1. 前往智能顾问-数字资产-订阅中心,进入 报告订阅 页面。

2. 单击新建订阅,打开新建订阅弹窗。

3. 在步骤一:配置订阅中,选择订阅的报告类型并配置报告的发送频率、发送时间等订阅信息。

4. 单击下一步,进入步骤二,接收方式选择 Webhook 界面会显示以下字段:

·URL(必填):可公网访问的 HTTP 地址,内网地址(如 localhost、192.168.x.x 等)无法接收推送。

·HTTP 请求头(可选):仅支持填写 Authorization 字段的值,常用于身份认证场景。

5. 测试连通性,填写完 URL 后,建议先点击测试连通性,确保地址可用:

根据测试结果确认 URL 是否配置正确:

·测试通过:URL 可正常访问,继续下一步。

·测试失败:请检查 URL 是否正确、服务端是否正常,修正后重新测试。

6. 连通性测试通过后,单击确认完成订阅创建。

四、Webhook 回调请求参数

注意:说明:

注意:如需了解各报告类型的完整数据结构,请参见 Webhook 回调请求参数说明。

五、支持的报告类型

ReportType 报告类型 说明
0 日常巡检报告 账号级维度的云资源风险状况。
1 架构巡检报告 架构级维度的资源风险及变化趋势。
2 架构负载报告 架构级维度的资源性能与负载压力。
6 架构负载多维报告 架构级维度的多周期、多算法分析下资源容量水位与负载趋势。

六、回调配置

·请求方式:POST

·Content-Type:application/json

·Authentication:可选,Base64 加密

七、核心参数

字段 说明
SubId 订阅记录 ID
SubName 订阅名称
AppId / Uin 客户账号信息
ReportType 报告类型枚举
ReportTaskId 报告任务 UUID
ReportCreatedAt 报告生成时间(Unix 时间戳)
ReportData 报告数据(结构因类型而异)

八、响应规则

场景 规则
HTTP 200 视为投递成功
5xx / 429 / 网络错误 自动重试,最多 3 次
4xx 错误 不重试

九、注意事项

·文件有效期:Files 中的预签名 URL 有效 24 小时,请及时下载。

·文件类型:json(明细数据)、pdf(报告)、excel(数据表)。

·日志查看:投递日志记录在 webhook_push_log 表中。

十、特殊值说明

值 含义
9223372036854775807 第一天/第一个周的数据
— 或 – 无数据
riskLevel: -1 不支持评估
赞 (0)
上一篇 4天前
下一篇 4天前