文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 修改镜像白名单配置信息 - ChangeImageWhiteList
更新时间:2025-10-31 GMT+08:00
分享

修改镜像白名单配置信息 - ChangeImageWhiteList

功能介绍

修改镜像白名单配置信息

授权信息

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

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

URI

PUT /v5/{project_id}/image/whitelists/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

id

String

参数解释

白名单ID

约束限制

不涉及

取值范围

字符长度1-64位

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

global_image_type

String

参数解释

镜像类型

约束限制:

不涉及

取值范围:

  • local:本地镜像。

  • registry:仓库镜像。

默认取值:

不涉及

type

String

参数解释

白名单类型

约束限制:

不涉及

取值范围:

  • vulnerability:漏洞白名单。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

rule_type

String

参数解释

白名单规则类型

约束限制:

不涉及

取值范围:

  • all_images:白名单应用于全部镜像。

  • specific_image_types:白名单应用于指定镜像类型(仅用于指定仓库镜像类型)。

  • specific_images:白名单应用于指定镜像。

默认取值:

不涉及

query_info

query_info object

按照镜像查询条件指定镜像

image_info

Array of image_info objects

指定具体镜像

description

String

白名单的描述信息

表5 query_info

参数

是否必选

参数类型

描述

image_type

String

参数解释

镜像类型

约束限制:

不涉及

取值范围:

  • private_image:私有镜像仓库。

  • shared_image:共享镜像仓库。

  • instance_image:企业仓库。

  • harbor: harbor仓库。

  • jfrog : jfrog仓库。

默认取值:

不涉及

表6 image_info

参数

是否必选

参数类型

描述

id

Long

参数解释

仓库镜像id

约束限制

不涉及

取值范围

最小值1,最大值9223372036854775807

默认取值

不涉及

image_id

String

参数解释

本地镜像id

约束限制

不涉及

取值范围

字符长度0-64位

默认取值

不涉及

image_name

String

参数解释

镜像名称

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

不涉及

image_type

String

参数解释

镜像类型

约束限制:

不涉及

取值范围:

  • local_image:本地镜像。

  • private_image:私有镜像仓库。

  • shared_image:共享镜像仓库。

  • instance_image:企业仓库。

  • harbor: harbor仓库。

  • jfrog : jfrog仓库。

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档