文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 镜像仓库基线检查批量导出(支持全量导出) - BatchExportBaselineTask
更新时间:2025-10-31 GMT+08:00
分享

镜像仓库基线检查批量导出(支持全量导出) - BatchExportBaselineTask

功能介绍

镜像仓库基线检查批量导出(支持全量导出),若导出镜像类型为cicd类型的数据,需要传参image_type为cicd

授权信息

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

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

URI

POST /v5/{project_id}/image/baseline/export

表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)。

export_size

Integer

参数解释:

导出数据条数

约束限制:

不涉及

取值范围:

最小值0,最大值2147483647

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

image_id_list

Array of strings

参数解释:

要导出的镜像信息列表,operate_all参数为false时需要填写批量查询条件,image_id 镜像id,唯一镜像标识(注:对私有镜像和共享镜像来说是镜像列表返回的id)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483647

默认取值:

不涉及

operate_all

Boolean

参数解释

若为true全量查询,可筛选条件全部查询

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

image_type

String

参数解释:

镜像类型

约束限制:

不涉及

取值范围:

  • private_image: 私有镜像。

  • shared_image: 共享镜像。

  • local_image: 本地镜像。

  • instance_image: 企业镜像。

  • harbor: Harbor镜像。

  • jfrog: Jfrog镜像。

  • cicd: cicd镜像。

默认取值:

不涉及

vul_type

String

参数解释:

漏洞类型

约束限制:

不涉及

取值范围:

  • linux_vul : linux漏洞。

  • app_vul : 应用漏洞。

默认取值:

不涉及

scan_status

String

参数解释:

扫描状态

约束限制:

不涉及

取值范围:

  • unscan: 未扫描。

  • success: 扫描完成。

  • scanning: 扫描中。

  • failed: 扫描失败。

  • download_failed: 下载失败。

  • image_oversized: 镜像超大。

默认取值:

不涉及

namespace

String

参数解释:

组织名称(只有私有镜像和共享镜像有该字段,本地镜像没有)

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_name

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_version

String

参数解释:

镜像版本名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_id

String

参数解释:

镜像id

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

latest_version

Boolean

参数解释

仅关注最新版本镜像

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

image_size

Long

参数解释:

镜像大小

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

start_latest_update_time

Long

参数解释:

创建时间开始日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

end_latest_update_time

Long

参数解释:

创建时间结束日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

start_latest_scan_time

Long

参数解释:

最近一次扫描完成时间开始日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

end_latest_scan_time

Long

参数解释:

最近一次扫描完成时间结束日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

has_malicious_file

Boolean

参数解释

是否存在恶意文件

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

has_vul

Boolean

参数解释

是否存在软件漏洞

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

has_unsafe_setting

Boolean

参数解释

是否存在基线检查

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

risky

Boolean

参数解释

是否有安全风险

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

severity_level

String

参数解释:

镜像风险程度,在镜像扫描完成后展示。

约束限制:

不涉及

取值范围:

  • Security : 安全。

  • Low : 低危。

  • Medium : 中危。

  • High : 高危。

默认取值:

不涉及

instance_name

String

参数解释:

企业镜像实例名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

instance_id

String

参数解释:

企业仓库实例ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

cicd_name

String

参数解释:

cicd名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

build_command_risk_level

String

参数解释:

构建指令风险程度

约束限制:

不涉及

取值范围:

  • critical :严重。

  • high :高危。

  • medium :中危。

  • low :低危。

默认取值:

不涉及

build_command_risk_name

String

参数解释:

构建指令风险名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

build_command_rule_id_list

Array of strings

参数解释:

要导出的构建指令风险检测规则id列表。rule_id的值可以从接口/v5/{project_id}/image/build-command-risks的返回参数获取

约束限制:

不涉及

取值范围:

字符长度1-200位

默认取值:

不涉及

has_container

Boolean

参数解释

是否存在容器

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

vul_id_list

Array of strings

参数解释:

导出镜像漏洞时的漏洞id列表

约束限制:

不涉及

取值范围:

最小值0,最大值2048

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

record_total_num

Long

参数解释:

导出记录总数

取值范围:

最小值0,最大值2147483647

task_id

String

参数解释:

导出任务ID

取值范围:

字符长度1-256位

请求示例

{
  "operate_all" : true
}

响应示例

状态码:200

请求已成功

{
  "record_total_num" : 1,
  "task_id" : "asdwwqdtut01"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档