1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
DescribeScanTaskDetails 查询扫描任务详情 , 可以查询扫描进度信息/异常;
默认接口请求频率限制:20次/秒。
接口更新时间:2022-06-14 17:12:25。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeScanTaskDetails |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of Filters | 过滤条件。 示例值:查看 |
| Limit | 否 | 否 | Uint64 | 需要返回的数量,最大值为100 示例值: 10 |
| ModuleType | 是 | 否 | String | 模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线 示例值: Vul |
| Offset | 否 | 否 | Uint64 | 偏移量,默认为0。 示例值: 0 |
| TaskId | 是 | 否 | Uint64 | 任务ID 示例值: 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RiskEventCount | Uint64 | 风险事件个数 示例值: 1 |
| RiskMachineCount | Uint64 | 发现风险机器数 示例值: 1 |
| ScanBeginTime | String | 扫描开始时间 示例值: 2024-10-30 10:13:53 |
| ScanContent | Array of String | 扫描内容 示例值: ["0", "1", "2", "4", "5"] |
| ScanEndTime | String | 扫描结束时间 示例值: 2021-02-01 12:00:00 |
| ScanLeftTime | Uint64 | 扫描剩余时间 示例值: 12 |
| ScanMachineCount | Uint64 | 扫描机器总数 示例值: 1 |
| ScanProgress | Uint64 | 扫描进度 示例值: 10 |
| ScanTaskDetailList | Array of ScanTaskDetails | 扫描任务信息列表 示例值:查看 |
| ScanTime | Uint64 | 检测时间 示例值: 19 |
| StoppingAll | Bool | 任务是否全部正在被停止 ture是 示例值: true |
| TotalCount | Uint64 | 总数 示例值: 1 |
| Type | Uint64 | 0一键检测 1定时检测 示例值: 1 |
| VulCount | Uint64 | 扫描出漏洞个数 示例值: 0 |
| VulInfo | Array of VulDetailInfo | 漏洞信息 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter.IllegalRequest | 非法请求。 |
| InvalidParameter | 参数错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| InvalidParameterValue | 参数取值错误。 |
5. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeScanTaskDetails
<Public request parameters>
{
"ModuleType": "Vul",
"TaskId": 1
}
输出示例
{
"Response": {
"ScanContent": [
"cve"
],
"VulInfo": [
{
"CveId": "cve- ",
"CvssScore": 0,
"Name": "name",
"Reference": "ref",
"Level": 1,
"Fix": "fix",
"Descript": "desc",
"PublishTime": " 2019-12-25 11:57:15",
"VulId": 1,
"Cvss": "cvss",
"VulCategory": 1
}
],
"ScanMachineCount": 1,
"ScanTaskDetailList": [
{
"Status": "status",
"Uuid": "1c26308c-5493-4eaf-a817-112ec25f499e",
"ScanEndTime": " 2019-12-25 11:57:15",
"FailType": 1,
"HostName": "hostname",
"ScanBeginTime": " 2019-12-25 11:57:15",
"OsName": "osname",
"Quuid": "1c26308c-5493-4eaf-a817-112ec25f499e",
"HostIp": "10.1.1.15",
"RiskNum": 1,
"Id": 1,
"Description": "desc",
"MachineWanIp": "10.1.1.15",
"MachineExtraInfo": {
"WanIP": "10.1.1.15",
"PrivateIP": "10.1.1.15",
"NetworkType": 0,
"NetworkName": "name",
"InstanceID": "ins-dsf",
"HostName": "hostname"
}
}
],
"ScanEndTime": " 2019-12-25 11:57:15",
"ScanTime": 1,
"ScanProgress": 1,
"ScanLeftTime": 1,
"ScanBeginTime": " 2019-12-25 11:57:15",
"TotalCount": 1,
"RequestId": "acdd5474-6360-4fd4-bfc7-843162cb8116",
"RiskEventCount": 1,
"VulCount": 1,
"RiskMachineCount": 1,
"Type": 1,
"StoppingAll": false
}
}