查询cicd镜像列表 - ListCicdImages
功能介绍
查询cicd镜像列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/cicd/images
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
namespace |
否 |
String |
参数解释: 组织名称 约束限制: 不涉及 取值范围: 字符长度1-128位。 默认取值: 不涉及 |
|
image_name |
否 |
String |
参数解释: 镜像名称 取值范围: 字符长度1-128位 |
|
image_version |
否 |
String |
参数解释: 镜像版本 取值范围: 字符长度1-64位 |
|
sort_key |
否 |
String |
参数解释: 可排序字段 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
sort_dir |
否 |
String |
参数解释: 排序的顺序 约束限制: 不涉及 取值范围:
默认取值: 正序排序 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
image_id |
否 |
String |
参数解释: cicd镜像标识 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
cicd_name |
否 |
String |
参数解释: cicd名称 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
latest_version |
否 |
Boolean |
参数解释: 仅关注最新版本镜像 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
image_size |
否 |
Long |
参数解释: 镜像大小 约束限制: 不涉及 取值范围: 最小值0,最大值2147483547 默认取值: 不涉及 |
|
scan_status |
否 |
String |
参数解释 扫描状态 约束限制 不涉及 取值范围
默认取值: 不涉及 |
|
start_latest_update_time |
否 |
Long |
参数解释: 创建时间开始日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 最小值0,最大值9223372036854775807 默认取值: 不涉及 |
|
end_latest_update_time |
否 |
Long |
参数解释: 创建时间结束日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 最小值0,最大值9223372036854775807 默认取值: 不涉及 |
|
start_latest_scan_time |
否 |
Long |
参数解释: 最近一次扫描完成时间开始日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 最小值0,最大值9223372036854775807 默认取值: 不涉及 |
|
end_latest_scan_time |
否 |
Long |
参数解释: 最近一次扫描完成时间结束日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 最小值0,最大值9223372036854775807 默认取值: 不涉及 |
|
has_malicious_file |
否 |
Boolean |
参数解释: 是否存在恶意文件 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
has_unsafe_setting |
否 |
Boolean |
参数解释: 是否存在基线检查 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
has_vul |
否 |
Boolean |
参数解释: 是否存在软件漏洞 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
severity_level |
否 |
String |
参数解释 镜像风险程度,在镜像扫描完成后展示 约束限制 不涉及 取值范围
默认取值: 不涉及 |
|
risky |
否 |
Boolean |
参数解释: 有安全风险 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: cicd镜像总数 取值范围: 最小值0,最大值2147483547 |
|
data_list |
Array of CICDImageResponseInfo objects |
参数解释: cicd镜像列表 取值范围: 最小值0,最大值200 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
image_id |
String |
参数解释: cicd镜像标识 取值范围: 字符长度0-128位 |
|
cicd_name |
String |
参数解释: cicd名称 取值范围: 字符长度0-128位 |
|
namespace |
String |
参数解释: 命名空间 取值范围: 字符长度0-64位 |
|
image_name |
String |
参数解释: 镜像名称 取值范围: 字符长度0-128位 |
|
image_digest |
String |
参数解释: 镜像digest 取值范围: 字符长度0-128位 |
|
image_version |
String |
参数解释: 镜像版本 取值范围: 字符长度0-64位 |
|
registry_name |
String |
参数解释: 镜像仓库名称 取值范围: 字符长度1-128位 |
|
image_type |
String |
参数解释: 镜像类型 取值范围:
|
|
registry_type |
String |
参数解释: 镜像仓库类型 取值范围:
|
|
latest_version |
Boolean |
参数解释: 是否是最新版本 取值范围:
|
|
scan_status |
String |
参数解释: 扫描状态 取值范围:
|
|
scan_failed_desc |
String |
参数解释: 扫描失败原因,包含如下16种。
取值范围: 字符长度0-128位 |
|
scan_failed_code |
String |
参数解释: 扫描失败原因code,包含如下16种。
取值范围: 字符长度0-64位 |
|
image_size |
Long |
参数解释: 镜像大小 取值范围: 最小值0,最大值2147483547 |
|
latest_update_time |
Long |
参数解释: 镜像版本最后更新时间,时间单位 毫秒(ms) 取值范围: 最小值0,最大值9223372036854775807 |
|
latest_scan_time |
Long |
参数解释: 最近扫描时间,时间单位 毫秒(ms) 取值范围: 最小值0,最大值9223372036854775807 |
|
vul_num |
Integer |
参数解释: 漏洞个数 取值范围: 最小值0,最大值2147483647 |
|
unsafe_setting_num |
Integer |
参数解释: 基线扫描未通过数 取值范围: 最小值0,最大值2147483647 |
|
malicious_file_num |
Integer |
参数解释: 恶意文件数 取值范围: 最小值0,最大值2147483647 |
|
severity_level |
String |
参数解释: 镜像风险程度,在镜像扫描完成后展示 取值范围:
|
请求示例
无
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : {
"image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
"image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
"image_name" : "centos7",
"image_size" : "1000 单位(Bytes)",
"image_type" : "cicd",
"image_version" : "common",
"latest_scan_time" : 1691748641788,
"latest_update_time" : 1687664346000,
"latest_version" : false,
"malicious_file_num" : 0,
"namespace" : "aaa",
"scan_status" : "success",
"unsafe_setting_num" : 1,
"vul_num" : 111
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。