文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 查询swr镜像仓库镜像列表
更新时间：2024-11-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询swr镜像仓库镜像列表

功能介绍

查询swr镜像仓库镜像列表,如果需要从swr同步最新镜像，需要先调用“从swr同步镜像”接口

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/image/swr-repository

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，查询所有企业项目时填写：all_granted_eps

namespace

否

String

组织名称

image_name

否

String

镜像名称

image_version

否

String

镜像版本

latest_version

否

Boolean

仅关注最新版本镜像

offset

否

Integer

偏移量：指定返回记录的开始位置

limit

否

Integer

每页显示数量

image_type

是

String

镜像类型，包含如下:

  • private_image : 私有镜像仓库

  • shared_image : 共享镜像仓库

  • local_image : 本地镜像

  • instance_image : 企业镜像

scan_status

否

String

扫描状态，包含如下:

  • unscan : 未扫描

  • success : 扫描完成

  • scanning : 扫描中

  • failed : 扫描失败

  • waiting_for_scan : 等待扫描

instance_name

否

String

企业镜像实例名称

image_size

否

Long

镜像大小

start_latest_update_time

否

Long

创建时间开始日期，时间单位 毫秒（ms）

end_latest_update_time

否

Long

创建时间结束日期，时间单位 毫秒（ms）

start_latest_scan_time

否

Long

最近一次扫描完成时间开始日期，时间单位 毫秒（ms）

end_latest_scan_time

否

Long

最近一次扫描完成时间结束日期，时间单位 毫秒（ms）

has_malicious_file

否

Boolean

是否存在恶意文件

has_unsafe_setting

否

Boolean

是否存在基线检查

has_vul

否

Boolean

是否存在软件漏洞

instance_id

否

String

企业仓库实例ID，swr共享版无需使用该参数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

region

是

String

Region ID

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of PrivateImageRepositoryInfo objects

查询swr镜像仓库镜像列表
表5 PrivateImageRepositoryInfo

参数

参数类型

描述

id

Long

id

namespace

String

命名空间

image_name

String

镜像名称

image_id

String

镜像id

image_digest

String

镜像digest

image_version

String

镜像版本

image_type

String

镜像类型，包含如下2种。

  • private_image ：私有镜像。

  • shared_image ：共享镜像。

latest_version

Boolean

是否是最新版本

scan_status

String

扫描状态，包含如下2种。

  • unscan ：未扫描。

  • success ：扫描完成。

  • scanning ：正在扫描。

  • failed ：扫描失败。

  • download_failed ：下载失败。

  • image_oversized ：镜像超大。

  • waiting_for_scan ：等待扫描。

scan_failed_desc

String

扫描失败原因，包含如下14种。

  • "unknown_error" :未知错误

  • "authentication_failed":认证失败

  • "download_failed":镜像下载失败

  • "image_over_sized":镜像大小超限

  • "image_oversized":镜像超大

  • "failed_to_scan_vulnerability":漏洞扫描失败

  • "failed_to_scan_file":文件扫描失败

  • "failed_to_scan_software":软件扫描失败

  • "failed_to_check_sensitive_information":敏感信息核查失败

  • "failed_to_check_baseline":基线检查失败

  • "failed_to_check_software_compliance":软件合规检查失败

  • "failed_to_query_basic_image_information":基础镜像信息查询失败

  • "response_timed_out":响应超时

  • "database_error" : 数据库错误

  • "failed_to_send_the_scan_request" : 发送扫描请求失败

image_size

Long

镜像大小

latest_update_time

Long

镜像版本最后更新时间，时间单位 毫秒（ms）

latest_scan_time

Long

最近扫描时间，时间单位 毫秒（ms）

vul_num

Integer

漏洞个数

unsafe_setting_num

Integer

基线扫描未通过数

malicious_file_num

Integer

恶意文件数

domain_name

String

拥有者（共享镜像参数）

shared_status

String

共享镜像状态，包含如下2种。

  • expired ：已过期。

  • effective ：有效。

scannable

Boolean

是否可扫描

instance_name

String

企业版镜像实例名称

instance_id

String

企业版镜像实例ID

instance_url

String

企业版镜像实例URL

association_images

Array of AssociateImages objects

多架构关联镜像信息
表6 AssociateImages

参数

参数类型

描述

image_name

String

镜像名称

image_version

String

镜像版本

image_type

String

镜像类型

namespace

String

命名空间

image_digest

String

镜像digest

scan_status

String

扫描状态，包含如下2种。

  • unscan ：未扫描。

  • success ：扫描完成。

  • scanning ：正在扫描。

  • failed ：扫描失败。

  • download_failed ：下载失败。

  • image_oversized ：镜像超大。

  • waiting_for_scan ：等待扫描。

请求示例

查询镜像类型为私有镜像的swr镜像仓库镜像列表。

GET https://{endpoint}/v5/{project_id}/image/swr-repository?offset=0&limit=50&image_type=private_image&latest_version=false&enterprise_project_id=all_granted_eps

响应示例

状态码： 200

查询swr镜像仓库镜像列表,包括私有镜像列表和共享镜像列表（通过传参image_type控制）

{
  "total_num" : 3,
  "data_list" : [ {
    "id" : "111(私有镜像举例)",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "centos7",
    "image_size" : "1000 单位（Bytes）",
    "image_type" : "private_image",
    "image_version" : "common",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "222(共享镜像举例)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 单位（Bytes）",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "333(企业镜像举例)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 单位（Bytes）",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "企业实例名称",
    "instance_id" : "",
    "instance_url" : ""
  } ]
}

状态码

状态码

描述

200

查询swr镜像仓库镜像列表,包括私有镜像列表和共享镜像列表（通过传参image_type控制）

错误码

请参见错误码。

父主题： 容器镜像

相关文档