1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
DescribeScanTaskDetails 查询扫描任务详情 , 可以查询扫描进度信息/异常;
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeScanTaskDetails。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ModuleType | 是 | String | 模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线 示例值：Vul |
| TaskId | 是 | Integer | 任务ID 示例值：1 |
| Filters.N | 否 | Array of Filters | 过滤参数 示例值：[] |
| Limit | 否 | Integer | 需要返回的数量，最大值为100 示例值：10 |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ScanTaskDetailList | Array of ScanTaskDetails | 扫描任务信息列表 示例值：[] |
| TotalCount | Integer | 总数 示例值：1 |
| ScanMachineCount | Integer | 扫描机器总数 示例值：1 |
| RiskMachineCount | Integer | 发现风险机器数 示例值：1 |
| ScanBeginTime | String | 扫描开始时间 示例值：xxx |
| ScanEndTime | String | 扫描结束时间 示例值：xxx |
| ScanTime | Integer | 检测时间 示例值：xxx |
| ScanProgress | Integer | 扫描进度 示例值：10 |
| ScanLeftTime | Integer | 扫描剩余时间 示例值：xxx |
| ScanContent | Array of String | 扫描内容 示例值：xxx |
| VulInfo | Array of VulDetailInfo | 漏洞信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
| RiskEventCount | Integer | 风险事件个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Type | Integer | 0一键检测 1定时检测 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| StoppingAll | Boolean | 任务是否全部正在被停止 ture是 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| VulCount | Integer | 扫描出漏洞个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScanTaskDetails
<公共请求参数>
{
"ModuleType": "Vul",
"TaskId": 1
}输出示例
{
"Response": {
"ScanContent": [
"xx"
],
"VulInfo": [
{
"CveId": "xx",
"CvssScore": 0.0,
"Name": "xx",
"Reference": "xx",
"Level": 1,
"Fix": "xx",
"Descript": "xx",
"PublishTime": "xx",
"VulId": 1,
"Cvss": "xx",
"VulCategory": 1
}
],
"ScanMachineCount": 1,
"ScanTaskDetailList": [
{
"Status": "xx",
"Uuid": "xx",
"ScanEndTime": "xx",
"FailType": 1,
"HostName": "xx",
"ScanBeginTime": "xx",
"OsName": "xx",
"Quuid": "xx",
"HostIp": "xx",
"RiskNum": 1,
"Id": 1,
"Description": "xx"
}
],
"ScanEndTime": "xx",
"ScanTime": 1,
"ScanProgress": 1,
"ScanLeftTime": 1,
"ScanBeginTime": "xx",
"TotalCount": 1,
"RequestId": "xx",
"RiskEventCount": 1,
"VulCount": 1,
"RiskMachineCount": 1,
"Type": 1,
"StoppingAll": false
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.IllegalRequest | 非法请求。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |