1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
DescribeScanState 该接口能查询对应模块正在进行的扫描任务状态
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeScanState。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ModuleType | 是 | String | 模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线 示例值:Vul |
Filters.N | 否 | Array of Filters | 过滤参数; 示例值:[ { "Name": "StrategyId", "Values": [ "1" ], "ExactMatch": true } ] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ScanState | Integer | 0 从未扫描过、 1 扫描中、 2扫描完成、 3停止中、 4停止完成 示例值:2 |
Schedule | Integer | 扫描进度 示例值:10 |
TaskId | Integer | 任务Id 示例值:1 |
VulId | Array of Integer | 任务扫描的漏洞id 示例值:[1,2,4] |
Type | Integer | 0一键检测 1定时检测 示例值:1 |
ScanBeginTime | String | 开始扫描时间 示例值:2021-07-09 15:04:01 |
RiskEventCount | Integer | 扫描漏洞数 示例值:1 |
ScanEndTime | String | 扫描结束时间 示例值:2021-07-09 15:04:01 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScanState
<公共请求参数>
{
"ModuleType": "Vul"
}
输出示例
{
"Response": {
"RiskEventCount": 1,
"ScanEndTime": "2023-10-26 14:56:29",
"Schedule": 1,
"ScanState": 1,
"ScanBeginTime": "2023-10-26 14:56:29",
"RequestId": "c741a4fd-776f-499b-85a2-7bc70fd5b92s",
"TaskId": 1,
"VulId": [
1
],
"Type": 1
}
}
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 | 非法请求。 |
InvalidParameter.InvalidFormat | 参数格式错误。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |