镜像仓库创建镜像一键扫描任务

最近更新时间: 2024-09-03 18:49:49

1. 接口描述

接口请求域名: tcss.api3.cloud.sunhongs.com。

镜像仓库创建镜像一键扫描任务

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

接口更新时间:2023-11-10 10:21:13。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:CreateAssetImageRegistryScanTaskOneKey
Version 是 否 String 公共参数,本接口取值:2020-11-01
Region 是 否 String 公共参数,本接口不需要传递此参数。
All 否 否 Bool 此参数对外不可见。
是否扫描全部镜像(废弃)
Images 否 否 Array of ImageInfo 此参数对外不可见。
扫描的镜像列表
ScanType 否 否 Array of String 此参数对外不可见。
扫描类型数组
Id 否 否 Array of Uint64 此参数对外不可见。
扫描的镜像列表Id
IsLatest 否 否 Bool 此参数对外不可见。
是否最新镜像
ScanScope 否 否 Uint64 此参数对外不可见。
扫描范围 0全部镜像,1自选镜像,2推荐扫描镜像
RegistryType 否 否 Array of String 此参数对外不可见。
仓库类型
Namespace 否 否 Array of String 此参数对外不可见。
命名空间
ContainerRunning 否 否 Bool 此参数对外不可见。
是否存在运行中的容器
Timeout 否 否 Uint64 此参数对外不可见。
任务超时时长单位s

3. 输出参数

参数名称 类型 描述
TaskID Uint64 扫描任务id
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter
ResourceNotFound
FailedOperation