容器安全服务创建镜像扫描任务-镜像安全相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tcss.tencentcloudapi.com 。

容器安全创建镜像扫描任务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAssetImageScanTask。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
Images.N	否	Array of String	需要扫描的镜像列表；全部镜像，镜像列表和根据过滤条件筛选三选一。示例值：["sha256:c849b2717cdc2efcea3e032d121dcbfbc6f212ba37e4d2af50e53c7c6ecb****"]
ScanVul	否	Boolean	扫描漏洞；漏洞，木马和风险需选其一示例值：True
ScanVirus	否	Boolean	扫描木马；漏洞，木马和风险需选其一示例值：False
ScanRisk	否	Boolean	扫描风险；漏洞，木马和风险需选其一示例值：False
Filters.N	否	Array of AssetFilters	根据过滤条件筛选出镜像；全部镜像，镜像列表和根据过滤条件筛选三选一。示例值：[{"Name":"Namespace","Values":["name1"]}]
ExcludeImageIds.N	否	Array of String	根据过滤条件筛选出镜像，再排除个别镜像示例值：[sha256:80beff5ff34259ceb7fbe9cd10b2d94912618f5b5595f234349c5bb0cd4f9211]
ContainerRunning	否	Boolean	镜像是否存在运行中的容器示例值：TRUE
ScanScope	否	Integer	扫描范围 0 全部授权镜像，1自选镜像，2 推荐扫描示例值：2
Timeout	否	Integer	任务超时时长单位秒，默认1小时示例值：3600
IsOneClickScanningTask	否	Boolean	一键扫描任务。默认false表示非一键扫描，true一键扫描示例值：FALSE

3. 输出参数

参数名称	类型	描述
TaskID	String	任务id 示例值：41033
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建镜像扫描任务

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAssetImageScanTask
<公共请求参数>

{
    "ScanVirus": true,
    "ScanRisk": true,
    "ScanVul": true,
    "All": true,
    "Images": []
}

输出示例

{
    "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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.ErrAlreadyScanning	在扫描中或无扫描权限建议授权后扫描。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.InvalidFormat	参数格式错误。
InvalidParameter.ParsingError	参数解析错误。
ResourceNotFound	资源不存在。

创建镜像扫描任务

本页目录：