1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
镜像仓库创建镜像扫描任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateAssetImageRegistryScanTask。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| All | 否 | Boolean | 是否扫描全部镜像 示例值：False |
| Images.N | 否 | Array of ImageInfo | 扫描的镜像列表 示例值：["sha256:gydgshdg62656***"] |
| ScanType.N | 否 | Array of String | 扫描类型数组 示例值：["CVE"] |
| Id.N | 否 | Array of Integer | 扫描的镜像列表 示例值：[137828455] |
| Filters.N | 否 | Array of AssetFilters | 过滤条件 示例值：[{"Name":"ScanScope","Values":["2"]}] |
| ExcludeImageList.N | 否 | Array of Integer | 不需要扫描的镜像列表, 与Filters配合使用 示例值：["sha256:gydgshdg62656***"] |
| OnlyScanLatest | 否 | Boolean | 是否仅扫描各repository最新版的镜像, 与Filters配合使用 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskID | Integer | 返回的任务ID 示例值：2 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 正常请求
正常请求
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAssetImageRegistryScanTask
<公共请求参数>
{
"All": false,
"Id": [
1256299843
],
"OnlyScanLatest": false
}输出示例
{
"Response": {
"RequestId": "538366ac-d056-4f69-92ca-cf9bc6c9463b",
"TaskID": 2
}
}示例2 镜像仓库创建镜像扫描任务
镜像仓库创建镜像扫描任务
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAssetImageRegistryScanTask
<公共请求参数>
{
"Id": [
8741110
],
"ScanType": [
"CVE",
"VIRUS",
"RISK"
]
}输出示例
{
"Response": {
"RequestId": "68d5d49c-4b6b-46af-b060-46f521db0400"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
