1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
运行时文件查杀一键扫描
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateVirusScanTask。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ScanPathAll | 是 | Boolean | 是否扫描所有路径 示例值：true |
| ScanRangeType | 是 | Integer | 扫描范围0容器1主机节点 示例值：1 |
| ScanRangeAll | 是 | Boolean | true 全选，false 自选 示例值：true |
| Timeout | 是 | Integer | 超时时长，单位小时 示例值：1 |
| ScanPathType | 否 | Integer | 当ScanPathAll为false生效 0扫描以下路径 1、扫描除以下路径 示例值：0 |
| ScanIds.N | 否 | Array of String | 自选扫描范围的容器id或者主机id 根据ScanRangeType决定 示例值：[] |
| ScanPath.N | 否 | Array of String | 自选排除或扫描的地址 示例值：[] |
| ScanPathMode | 否 | String | 扫描路径模式： SCAN_PATH_ALL：全部路径 SCAN_PATH_DEFAULT：默认路径 SCAN_PATH_USER_DEFINE：用户自定义路径 示例值：SCAN_PATH_ALL |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskID | String | 任务id |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 运行时文件查杀一键扫描
运行时文件查杀一键扫描
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVirusScanTask
<公共请求参数>
{
"ScanRangeAll": true,
"ScanPathAll": true,
"ScanRangeType": 1,
"ScanPathMode": "SCAN_PATH_DEFAULT",
"Timeout": 2
}输出示例
{
"Response": {
"RequestId": "a6d8d540-940f-47d9-8d7f-daac832ba5b4",
"TaskID": "6013a6c334b9a9000cf519be"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.MainDBFail | 操作数据库失败。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |