镜像仓库查询一键镜像扫描状态
最近更新时间: 2024-09-03 18:49:50
1. 接口描述
接口请求域名: tcss.api3.cloud.sunhongs.com。
镜像仓库查询一键镜像扫描状态
默认接口请求频率限制:20次/秒。
接口更新时间:2023-11-10 10:21:13。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeAssetImageRegistryScanStatusOneKey |
Version | 是 | 否 | String | 公共参数,本接口取值:2020-11-01 |
Region | 是 | 否 | String | 公共参数,本接口不需要传递此参数。 |
Images | 否 | 否 | Array of ImageInfo | 此参数对外不可见。 需要获取进度的镜像列表 |
All | 否 | 否 | Bool | 此参数对外不可见。 是否获取全部镜像 |
Id | 否 | 否 | Array of Uint64 | 此参数对外不可见。 需要获取进度的镜像列表Id |
TaskID | 否 | 否 | Uint64 | 此参数对外不可见。 获取进度的任务ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ImageTotal | Uint64 | 镜像个数 |
ImageScanCnt | Uint64 | 扫描镜像个数 |
ImageStatus | ImageProgress | 扫描进度列表 |
SuccessCount | Uint64 | 安全个数 |
RiskCount | Uint64 | 风险个数 |
Schedule | Uint64 | 总的扫描进度 |
Status | String | 总的扫描状态 |
ScanRemainTime | Uint64 | 扫描剩余时间 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
MissingParameter | |
InternalError | |
ResourceNotFound |