文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 仓库镜像/ 查询仓库镜像列表 - ListRegistryImages

更新时间：2025-10-31 GMT+08:00

查看PDF

查询仓库镜像列表 - ListRegistryImages

功能介绍

查询仓库镜像列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/image/registries/images

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。约束限制: 不涉及取值范围: 字符长度1-256位默认取值: 不涉及

表2 Query参数
参数	是否必选	参数类型	描述
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位
registry_name	否	String	参数解释: 仓库名称取值范围: 字符长度1-128位
offset	否	Integer	参数解释: 偏移量：指定返回记录的开始位置约束限制: 不涉及取值范围: 最小值0，最大值2000000 默认取值: 默认为0
image_type	否	String	参数解释: 镜像类型约束限制: 不涉及取值范围: private_image：SWR私有镜像。 shared_image：SWR共享镜像。 instance_image：SWR企业版镜像。 harbor：Harbor仓库镜像。 jfrog：Jfrog镜像。默认取值: 不涉及
sort_key	否	String	参数解释: 可排序字段约束限制: 不涉及取值范围: latest_scan_time：最近扫描时间。默认取值: 不涉及
sort_dir	否	String	参数解释: 排序的顺序约束限制: 不涉及取值范围: asc : 正序 desc : 倒序默认取值: 正序排序
limit	否	Integer	参数解释: 每页显示个数约束限制: 不涉及取值范围: 取值1-200 默认取值: 10
latest_version	否	Boolean	仅关注最新版本镜像
image_size	否	Long	参数解释: 镜像大小约束限制: 不涉及取值范围: 取值0-2147483547 默认取值: 不涉及
scan_status	否	String	参数解释: 扫描状态约束限制: 不涉及取值范围: unscan：未扫描。 success：扫描完成。 scanning：扫描中。 failed：扫描失败。 waiting_for_scan：等待扫描。默认取值: 不涉及
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 默认取值: 不涉及
start_latest_sync_time	否	Long	参数解释: 最近一次同步完成时间开始日期，时间单位毫秒（ms）约束限制: 不涉及取值范围: 取值0-9223372036854775807 默认取值: 不涉及
end_latest_sync_time	否	Long	参数解释: 最近一次同步完成时间结束日期，时间单位毫秒（ms）约束限制: 不涉及取值范围: 取值0-9223372036854775807 默认取值: 不涉及
has_malicious_file	否	Boolean	是否存在恶意文件
has_unsafe_setting	否	Boolean	是否存在基线检查风险
has_vul	否	Boolean	是否存在软件漏洞
risky	否	Boolean	有安全风险
instance_id	否	String	参数解释：企业仓库实例ID，SWR企业版可以使用该参数约束限制：不涉及取值范围：字符长度0-128位默认取值：不涉及
instance_name	否	String	参数解释：企业镜像实例名称，SWR企业版可以使用该参数约束限制：不涉及取值范围：字符长度0-128位默认取值：不涉及
is_multarch	否	Boolean	是否是多架构镜像
severity_level	否	String	参数解释: 镜像风险程度，在镜像扫描完成后展示约束限制: 不涉及取值范围: Security：安全。 Low：低危。 Medium：中危。 High：高危。默认取值: 不涉及

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。约束限制: 不涉及取值范围: 字符长度1-32768位默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total_num	Integer	参数解释: 总数取值范围: 0-2147483547
data_list	Array of RegistryImagesInfo objects	仓库镜像列表

表5 RegistryImagesInfo
参数	参数类型	描述
id	Long	参数解释: id 取值范围: 最小值0，最大值9223372036854775807
namespace	String	参数解释: 组织名称取值范围: 字符长度0-64位
image_name	String	参数解释: 镜像名称取值范围: 字符长度0-128位
image_id	String	参数解释: 镜像id 取值范围: 字符长度0-64位
image_digest	String	参数解释: 镜像digest 取值范围: 字符长度0-128位
image_version	String	参数解释: 镜像版本取值范围: 字符长度0-64位
image_type	String	参数解释: 镜像类型取值范围: private_image：SWR私有镜像。 shared_image：SWR共享镜像。 instance_image：SWR企业版镜像。 harbor：Harbor仓库镜像。 jfrog：Jfrog镜像。
registry_id	String	参数解释: 镜像仓id 取值范围: 字符长度1-64位
registry_name	String	参数解释: 镜像仓库名称取值范围: 字符长度1-128位
registry_type	String	参数解释：镜像仓库类型取值范围： SwrPrivate：swr私有。 SwrShared：swr共享。 SwrEnterprise：swr企业。 Harbor：harbor仓库。 Jfrog：jfrog仓库。 Other：其他仓库。
latest_version	Boolean	是否是最新版本
scan_status	String	参数解释：扫描状态取值范围： unscan：未扫描。 success：扫描完成。 scanning：正在扫描。 failed：扫描失败。 download_failed：下载失败。 image_oversized：镜像超大。 waiting_for_scan：等待扫描。
scan_failed_desc	String	参数解释：扫描失败原因描述取值范围：扫描失败原因code和描述对应关系如下 unknown_error：未知错误。 authentication_failed：认证失败。 download_failed：镜像下载失败。请向技术人员寻求帮助。 image_over_sized：镜像大小超限，不支持扫描。建议精简镜像。 get_detail_info_not_found：获取镜像详细信息失败，镜像仓中可能已经不存在此镜像。请重新同步最新镜像。 image_layer_over_sized：镜像层数超限，不支持扫描。建议精简镜像。 schema_v1_not_support：Schema V1镜像不支持扫描。建议升级到V2版本。 access_swr_failed：访问SWR服务出错。请向技术人员寻求帮助。 swr_authentication_error：缺少SWR授权。请参考镜像授权指导设置权限。 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：基础镜像信息查询失败。 failed_to_check_build_cmd：镜像构建指令扫描失败。 response_timed_out：响应超时。 database_error：数据库错误。 failed_to_send_the_scan_request：发送扫描请求失败。
scan_failed_code	String	参数解释：扫描失败原因code 取值范围：扫描失败原因code和描述对应关系如下 unknown_error：未知错误。 authentication_failed：认证失败。 download_failed：镜像下载失败。请向技术人员寻求帮助。 image_over_sized：镜像大小超限，不支持扫描。建议精简镜像。 get_detail_info_not_found：获取镜像详细信息失败，镜像仓中可能已经不存在此镜像。请重新同步最新镜像。 image_layer_over_sized：镜像层数超限，不支持扫描。建议精简镜像。 schema_v1_not_support：Schema V1镜像不支持扫描。建议升级到V2版本。 access_swr_failed：访问SWR服务出错。请向技术人员寻求帮助。 swr_authentication_error：缺少SWR授权。请参考镜像授权指导设置权限。 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：基础镜像信息查询失败。 failed_to_check_build_cmd：镜像构建指令扫描失败。 response_timed_out：响应超时。 database_error：数据库错误。 failed_to_send_the_scan_request：发送扫描请求失败。
image_size	Long	参数解释: 镜像大小取值范围: 取值0-2147483547
latest_update_time	Long	参数解释: 镜像版本最后更新时间，时间单位毫秒（ms）取值范围: 取值0-9223372036854775807
latest_scan_time	Long	参数解释: 最近扫描时间，时间单位毫秒（ms）取值范围: 取值0-9223372036854775807
latest_sync_time	Long	参数解释: 最近同步时间，时间单位毫秒（ms）取值范围: 取值0-9223372036854775807
vul_num	Integer	参数解释: 漏洞个数取值范围: 取值0-2147483647
unsafe_setting_num	Integer	参数解释: 基线扫描未通过数取值范围: 取值0-2147483647
malicious_file_num	Integer	参数解释: 恶意文件数取值范围: 取值0-2147483647
domain_name	String	参数解释: 拥有者（共享镜像参数）取值范围: 字符长度0-128
shared_status	String	参数解释：共享镜像状态取值范围： expired：已过期。 effective：有效。
scannable	Boolean	是否可扫描
is_multiple_arch	Boolean	是否是多架构镜像
instance_name	String	参数解释: 企业版镜像实例名称取值范围: 字符长度0-128
instance_id	String	参数解释: 企业版镜像实例ID 取值范围: 字符长度0-64
instance_url	String	参数解释: 企业版镜像实例URL 取值范围: 字符长度0-256
severity_level	String	参数解释: 镜像风险程度，在镜像扫描完成后展示取值范围: Security：安全。 Low：低危。 Medium：中危。 High：高危。
association_images	Array of AssociateImagesInfo objects	多架构关联镜像信息

表6 AssociateImagesInfo
参数	参数类型	描述
id	Long	参数解释: id 取值范围: 最小值0，最大值9223372036854775807
image_id	String	参数解释: 镜像id 取值范围: 字符长度0-64位
image_name	String	参数解释: 镜像名称取值范围: 字符长度0-128位
image_version	String	参数解释: 镜像版本取值范围: 字符长度0-64位
image_type	String	参数解释: 镜像类型取值范围: private_image：SWR私有镜像。 shared_image：SWR共享镜像。 instance_image：SWR企业版镜像。 harbor：Harbor仓库镜像。 jfrog：Jfrog镜像。
namespace	String	参数解释: 组织名称取值范围: 字符长度0-64位
image_digest	String	参数解释: 镜像digest 取值范围: 字符长度0-128位
scan_status	String	参数解释：扫描状态取值范围： unscan：未扫描。 success：扫描完成。 scanning：正在扫描。 failed：扫描失败。 download_failed：下载失败。 image_oversized：镜像超大。 waiting_for_scan：等待扫描。
vul_num	Integer	参数解释: 漏洞个数取值范围: 取值0-2147483647
unsafe_setting_num	Integer	参数解释: 基线扫描未通过数取值范围: 取值0-2147483647
malicious_file_num	Integer	参数解释: 恶意文件数取值范围: 取值0-2147483647

请求示例

无

响应示例

状态码：200

请求已成功

{
  "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" : "failed",
    "scan_failed_desc" : "认证失败",
    "scan_failed_code" : "authentication_failed",
    "scannable" : true,
    "unsafe_setting_num" : 0,
    "vul_num" : 0,
    "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	请求已成功

错误码

请参见错误码。

父主题：仓库镜像

上一篇：仓库镜像

下一篇：创建同步镜像任务 - CreateImageSynchronizeTask

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问