新增镜像白名单 - AddImageWhiteLists
功能介绍
新增镜像白名单,目前仅支持漏洞白名单
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/image/whitelists
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
global_image_type |
是 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
type |
是 |
String |
参数解释: 白名单类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
vul_type |
否 |
String |
参数解释: 漏洞类型(只在查询漏洞白名单时使用) 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
vul_ids |
否 |
Array of strings |
漏洞id列表(只在新增漏洞白名单时使用) |
|
rule_type |
是 |
String |
参数解释: 白名单规则类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
query_info |
否 |
query_info object |
按照镜像查询条件指定镜像 |
|
image_info |
否 |
Array of image_info objects |
指定具体镜像 |
|
description |
否 |
String |
白名单的描述信息 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
image_type |
否 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
Long |
参数解释: 仓库镜像id 约束限制: 不涉及 取值范围: 最小值1,最大值9223372036854775807 默认取值: 不涉及 |
|
image_id |
否 |
String |
参数解释: 本地镜像id 约束限制: 不涉及 取值范围: 字符长度0-64位 默认取值: 不涉及 |
|
image_name |
否 |
String |
参数解释: 镜像名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
image_type |
否 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。