1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取扫描漏洞任务详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVulScanTaskDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Id | 是 | Integer | 任务id 示例值:127 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-6f5795752f66e429"] |
| Filters.N | 否 | Array of Filters | 过滤条件,支持以下 Name: |
| Limit | 否 | Integer | 分页大小,默认 10,最大 100 示例值:2 |
| Offset | 否 | Integer | 分页偏移,从 0 开始 示例值:0 |
| Order | 否 | String | 排序方向:asc(升序)/ desc(降序),默认 desc 示例值:DESC |
| By | 否 | String | 排序字段,默认按创建时间(CreateTime)排序 示例值:CreateTime |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of VulScanTaskDetail | 任务详情列表 |
| Total | Integer | 总数 示例值:1 |
| Vuls | Integer | 漏洞数量 示例值:1 |
| Scanned | Integer | 扫描数量 示例值:51 |
| Risk | Integer | 风险数量 示例值:1 |
| Failed | Integer | 失败数量 示例值:24 |
| Progress | Integer | 扫描进度(0-100) 示例值:100 |
| TaskPdf | String | 任务pdf报告地址 示例值:https://*r-1**8499.cos.ap-guangzhou.myqcloud.com/vulsan |
| TaskExcel | String | 任务excel报告地址 示例值:https://*r-1**8499.cos.ap-guangzhou.myqcloud.com/vulsan |
| StartTime | String | 任务开始时间,格式:2006-01-02T15:04:05+08:00 示例值:2026-06-10T12:31:14Z |
| EndTime | String | 任务结束时间,格式:2006-01-02T15:04:05+08:00 示例值:2026-06-10T13:33:00Z |
| VulId | Array of Integer | 漏洞ID 示例值:[2563] |
| KbNo | Array of String | KB编号 示例值:["KB198877"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取漏洞扫描任务详情
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulScanTaskDetail
<公共请求参数>
{
"Id": 127,
"Filters": [
{
"Name": "InstanceId",
"Values": [
"ins-2f***t2k"
]
}
],
"Limit": 2,
"Offset": 0,
"Order": "DESC",
"By": "CreateTime"
}
输出示例
{
"Response": {
"EndTime": "2026-06-10T13:33:00Z",
"Failed": 24,
"List": [
{
"AppId": 260083796,
"Description": "",
"EndTime": "2026-06-10T12:33:13Z",
"Id": "2346",
"InstanceId": "ins-2f****2k",
"InstanceName": "tke_cls-dqum4px0_master_etcd3",
"OS": "TencentOS Server 3.1 (Final)",
"PrivateIp": "172.16.0.108",
"PublicIp": "",
"StartTime": "2026-06-10T12:32:44Z",
"Status": "SUCCESS",
"Vuls": 0
}
],
"Progress": 100,
"Risk": 1,
"Scanned": 51,
"StartTime": "2026-06-10T12:31:14Z",
"TaskExcel": "https://*****r*-1**8*4**99.cos.ap-guangzhou.myqcloud.com/vul*s*an**",
"TaskPdf": "https://*****r*-1**8*4**99.cos.ap-guangzhou.myqcloud.com/vul*s*an**",
"Total": 1,
"Vuls": 1,
"RequestId": "4df6736c-24d7-48e9-8876-dde3a615328b"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |