1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
查询当前租户风险中心未处理风险概览。默认查询最近 7 天；自定义时间范围需同时传 StartTime 和 EndTime。结果在 Response.Data 的 JSON 字符串中。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCfwRiskOverview。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| StartTime | 否 | String | 自定义开始时间。可选，格式 YYYY-MM-DD HH:MM:SS；必须和 EndTime 同时传。 示例值：2026-07-09 00:00:00 |
| EndTime | 否 | String | 自定义结束时间。可选，格式 YYYY-MM-DD HH:MM:SS；必须和 StartTime 同时传。 示例值：2026-07-09 23:59:59 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 查询结果。UTF-8 JSON object 字符串；调用方需解析 Response.Data。 示例值：{"breakdown":{"data_leak_ai_instance_total":0,"data_leak_out_total":1,"data_leak_total":0,"port_risk_total":6,"weak_password_total":0},"end_time":"2026-07-09 23:59:59","start_time":"2026-07-09 00:00:00","total_unhandled_risks":7} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询风险概览
不传时间时默认查询最近 7 天；total_unhandled_risks 等于 breakdown 五类未处理风险之和。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwRiskOverview
<公共请求参数>
{
"StartTime": "2026-06-01 00:00:00",
"EndTime": "2026-06-02 00:00:00"
}输出示例
{
"Response": {
"Data": "{\"start_time\":\"2026-06-01 00:00:00\",\"end_time\":\"2026-06-02 00:00:00\",\"total_unhandled_risks\":5,\"breakdown\":{\"data_leak_total\":1,\"data_leak_out_total\":1,\"data_leak_ai_instance_total\":1,\"port_risk_total\":1,\"weak_password_total\":1}}",
"RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ResponseTooLarge | FailedOperation.ResponseTooLarge |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
