文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 镜像仓库镜像批量扫描 - BatchScanSwrImage
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

镜像仓库镜像批量扫描 - BatchScanSwrImage

功能介绍

镜像仓库镜像批量扫描

授权信息

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

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

URI

POST /v5/{project_id}/image/batch-scan

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

主机所属的企业项目ID。

开通企业项目功能后才需要配置企业项目。

企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

region

否

String

Region ID
表4 请求Body参数

参数

是否必选

参数类型

描述

repo_type

否

String

仓库类型，现阶段接入了swr镜像仓库，包含如下:

  • SWR : SWR镜像仓库

image_info_list

否

Array of BatchScanSwrImageInfo objects

要扫描的镜像信息列表，operate_all参数为false时为必填

operate_all

否

Boolean

若为true全量查询，可筛选条件全部查询，若image_info_list为空，则必填

namespace

否

String

组织名称

image_name

否

String

镜像名称

image_version

否

String

镜像版本

image_type

是

String

镜像类型，包含如下:

  • private_image：SWR私有镜像仓库。

  • shared_image：SWR共享镜像仓库。

  • instance_image：SWR企业仓库。

scan_status

否

String

扫描状态，包含如下:

  • unscan : 未扫描

  • success : 扫描完成

  • scanning : 扫描中

  • failed : 扫描失败

  • download_failed : 下载失败

  • image_oversized : 镜像超大

latest_version

否

Boolean

仅关注最新版本镜像

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）
表5 BatchScanSwrImageInfo

参数

是否必选

参数类型

描述

namespace

否

String

命名空间

image_name

否

String

镜像名称

image_version

否

String

镜像版本

instance_id

否

String

企业实例ID

instance_url

否

String

下载企业镜像URL

响应参数

状态码：200

请求已成功

无

请求示例

  • 类型为私有镜像的镜像进行批量扫描，body体传参镜像列表，operate_all没有传参，说明需要镜像列表批量扫描。

    POST https://{endpoint}/v5/{project_id}/image/batch-scan

{
  "image_type" : "private_image",
  "image_info_list" : [ {
    "image_name" : "openjdk",
    "image_version" : "v8.8",
    "namespace" : "test"
  }, {
    "image_name" : "openjdk1",
    "image_version" : "v1.0",
    "namespace" : "test1"
  } ]
}

  • 类型为私有镜像的镜像进行全量扫描，body体没有传参镜像列表，operate_all=true，说明需要镜像列表全量扫描。

    POST https://{endpoint}/v5/{project_id}/image/batch-scan

{
  "image_type" : "private_image",
  "operate_all" : true
}

响应示例

无

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 容器镜像

相关文档