创建镜像扫描任务
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： tcss.api3.cloud.sunhongs.com。
容器安全创建镜像扫描任务
默认接口请求频率限制：20次/秒。
接口更新时间：2023-11-20 15:12:59。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateAssetImageScanTask |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-11-01 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| All | 否 | 否 | Bool | 此参数对外不可见。 是否扫描全部镜像；全部镜像，镜像列表和根据过滤条件筛选三选一。 |
| Images | 否 | 否 | Array of String | 此参数对外不可见。 需要扫描的镜像列表；全部镜像，镜像列表和根据过滤条件筛选三选一。 |
| ScanVul | 否 | 否 | Bool | 此参数对外不可见。 扫描漏洞；漏洞，木马和风险需选其一 |
| ScanVirus | 否 | 否 | Bool | 此参数对外不可见。 扫描木马；漏洞，木马和风险需选其一 |
| ScanRisk | 否 | 否 | Bool | 此参数对外不可见。 扫描风险；漏洞，木马和风险需选其一 |
| Filters | 否 | 否 | Array of AssetFilters | 此参数对外不可见。 根据过滤条件筛选出镜像；全部镜像，镜像列表和根据过滤条件筛选三选一。 |
| ExcludeImageIds | 否 | 否 | Array of String | 此参数对外不可见。 根据过滤条件筛选出镜像，再排除个别镜像 |
| ContainerRunning | 否 | 否 | Bool | 此参数对外不可见。 镜像是否存在运行中的容器 |
| ScanScope | 否 | 否 | Uint64 | 此参数对外不可见。 扫描范围 0 全部授权镜像，1自选镜像，2 推荐扫描 |
| Timeout | 否 | 否 | Uint64 | 此参数对外不可见。 任务超时时长单位秒，默认1小时 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskID | String | 任务id |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InternalError | |
| ResourceNotFound | |
| InvalidParameter.ParsingError | |
| InvalidParameter.InvalidFormat | |
| FailedOperation.ErrAlreadyScanning |