1. 接口描述
接口请求域名： cwp.api3.fincloud.tencent.cn。
DescribeScanState 该接口能查询对应模块正在进行的扫描任务状态
默认接口请求频率限制：20次/秒。
接口更新时间：2022-12-29 09:49:27。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeScanState |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-02-28 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of Filters | 过滤参数; 示例值：查看 |
| ModuleType | 是 | 否 | String | 模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线 示例值： Vul |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RiskEventCount | Uint64 | 扫描漏洞数 示例值： 1 |
| ScanBeginTime | String | 开始扫描时间 示例值： 2021-07-09 15:04:01 |
| ScanEndTime | String | 扫描结束时间 示例值： 2021-07-09 15:04:01 |
| ScanState | Uint64 | 0 从未扫描过、 1 扫描中、 2扫描完成、 3停止中、 4停止完成 示例值： 2 |
| Schedule | Uint64 | 扫描进度 示例值： 10 |
| TaskId | Uint64 | 任务Id 示例值： 1 |
| Type | Uint64 | 0一键检测 1定时检测 示例值： 1 |
| VulId | Array of Uint64 | 任务扫描的漏洞id 示例值： [1,2,4] |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.MissingParameter | 参数缺失。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameter.IllegalRequest | 非法请求。 |
| InvalidParameter | 参数错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| InvalidParameterValue | 参数取值错误。 |