文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 处置镜像漏洞 - HandleImageVulnerability
更新时间:2025-10-31 GMT+08:00
分享

处置镜像漏洞 - HandleImageVulnerability

功能介绍

处置镜像漏洞

授权信息

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

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

URI

POST /v5/{project_id}/image/vulnerability/handle

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

image_type

String

参数解释:

镜像类型

约束限制:

不涉及

取值范围:

  • local:本地镜像

  • registry:仓库镜像

  • cicd:cicd镜像

默认取值:

不涉及

type

String

参数解释:

漏洞类型

约束限制:

不涉及

取值范围:

  • linux_vul:Linux系统漏洞

  • app_vul:应用漏洞

默认取值:

不涉及

operate_type

String

参数解释:

对漏洞做的处置动作

约束限制:

不涉及

取值范围:

  • ignore:忽略

  • not_ignore:取消忽略

  • manual_repair:人工修复

  • add_to_whitelist:加白

默认取值:

不涉及

handle_status

String

参数解释:

需要处置的漏洞状态

约束限制:

不涉及

取值范围:

  • unhandled:待处理的漏洞

  • handled:已处理的漏洞

默认取值:

不涉及

select_type

String

参数解释:

处置漏洞范围的类型

约束限制:

不涉及

取值范围:

  • all_vul:处置所有漏洞

  • specific_image_all_vul:处置指定镜像的所有漏洞

  • specific_vul_all_image:处置指定漏洞的全部镜像

  • vul_view:通过漏洞维度指定需要处置的漏洞和镜像信息

  • image_view:通过镜像维度指定需要处置的漏洞和镜像信息

默认取值:

不涉及

image_id_list

Array of strings

参数解释:

select_type值为specific_image_all_vul时,该字段用于指定需要处置的镜像id列表

约束限制:

仅在select_type值为specific_image_all_vul时该字段有效

取值范围:

不涉及

默认取值:

不涉及

vul_id_list

Array of strings

参数解释:

select_type值为specific_vul_all_image时,该字段用于指定需要处置的漏洞id列表

约束限制:

仅在select_type值为specific_vul_all_image时该字段有效

取值范围:

不涉及

默认取值:

不涉及

vul_data_list

Array of vul_data_list objects

参数解释:

select_type值为vul_view时,该字段用于指定需要处置的漏洞和镜像信息

约束限制:

仅在select_type值为vul_view时该字段有效

取值范围:

不涉及

默认取值:

不涉及

image_data_list

Array of image_data_list objects

参数解释:

select_type值为image_view时,该字段用于指定需要处置的漏洞和镜像信息

约束限制:

仅在select_type值为image_view时该字段有效

取值范围:

不涉及

默认取值:

不涉及

remark

String

参数解释:

处置操作的描述信息

约束限制:

不涉及

取值范围:

字符长度0-512位

默认取值:

不涉及

表5 vul_data_list

参数

是否必选

参数类型

描述

vul_id

String

参数解释:

漏洞id

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

image_id_list

Array of strings

参数解释:

镜像id列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 image_data_list

参数

是否必选

参数类型

描述

image_id

String

参数解释:

镜像id

约束限制:

不涉及

取值范围:

字符长度0-512位

默认取值:

不涉及

vul_id_list

Array of strings

参数解释:

漏洞id列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

将project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx下的所有本地镜像未处置的Linux漏洞进行忽略

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/image/vulnerability/handle?enterprise_project_id=all_granted_eps

{
  "image_type" : "local",
  "type" : "linux_vul",
  "operate_type" : "ignore",
  "handle_status" : "unhandled",
  "select_type" : "all_vul"
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档