1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
查询漏洞扫描任务信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeVulScanInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| LocalTaskID | 否 | Integer | 本地镜像漏洞扫描任务ID，无则返回最近一次的漏洞任务扫描 示例值：1 |
| RegistryTaskID | 否 | Integer | 仓库镜像漏洞扫描任务ID，无则返回最近一次的漏洞任务扫描 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LocalImageScanCount | Integer | 本次扫描的本地镜像总数 示例值：1 |
| IgnoreVulCount | Integer | 忽略的漏洞数量 示例值：1 |
| ScanStartTime | String | 漏洞扫描的开始时间 示例值：2021-05-01 00:00:00 |
| ScanEndTime | String | 漏洞扫描的结束时间 示例值：2021-05-01 00:10:00 |
| FoundRiskImageCount | Integer | 发现风险镜像数量 示例值：1 |
| FoundVulCount | Integer | 本地发现漏洞数量 示例值：1 |
| ScanProgress | Float | 扫描进度 示例值：100 |
| RegistryImageScanCount | Integer | 本次扫描的仓库镜像总数 示例值：1 |
| LocalTaskID | Integer | 本地镜像最近一次的漏洞任务扫描ID 示例值：1 |
| Status | String | 扫描状态:NOT_SCAN:未扫描，SCANNING:扫描中,SCANNED:完成，CANCELED：扫描停止 |
| RemainingTime | Float | 剩余时间，秒 |
| RegistryTaskID | Integer | 仓库镜像最近一次的漏洞任务扫描ID |
| RegistryFoundVulCount | Integer | 仓库发现漏洞数量 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询漏洞扫描任务信息
输入示例
https://tcss.tencentcloudapi.com/?Action=DescribeVulScanInfo
&LocalTaskID=1
&RegistryTaskID=1
&<公共请求参数>输出示例
{
"Response": {
"Status": "xx",
"IgnoreVulCount": 0,
"LocalImageScanCount": 1,
"ScanEndTime": "xx",
"ScanProgress": 0.0,
"ScanStartTime": "xx",
"RegistryImageScanCount": 1,
"RegistryTaskID": 0,
"RemainingTime": 0.0,
"RegistryFoundVulCount": 0,
"RequestId": "xx",
"LocalTaskID": 0,
"FoundRiskImageCount": 0,
"FoundVulCount": 0
}
}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 | 内部错误。 |
| InternalError.MainDBFail | 操作数据库失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.MissingParameter | 缺少必须参数。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |