文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 查询镜像白名单列表 - ListImageWhiteLists
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询镜像白名单列表 - ListImageWhiteLists

功能介绍

查询镜像白名单列表，目前仅支持漏洞白名单

授权信息

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

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

URI

GET /v5/{project_id}/image/whitelists

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

offset

否

Integer

参数解释:

偏移量：指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

默认为0

limit

否

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

global_image_type

是

String

参数解释：

镜像类型

约束限制:

不涉及

取值范围:

  • local：本地镜像。

  • registry：仓库镜像。

默认取值:

不涉及

type

是

String

参数解释：

白名单类型

约束限制:

不涉及

取值范围:

  • vulnerability：漏洞白名单。

默认取值:

不涉及

vul_name

否

String

参数解释：

漏洞名称（只在查询漏洞白名单时使用）

约束限制：

不涉及

取值范围：

字符长度0-256位

默认取值：

不涉及

vul_type

否

String

参数解释：

漏洞类型（只在查询漏洞白名单时使用）

约束限制:

不涉及

取值范围:

  • linux_vul：linux漏洞。

  • app_vul：应用漏洞。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of ImageWhiteListDetailResponseInfo objects

参数解释:

白名单列表

取值范围:

最小值0，最大值200
表5 ImageWhiteListDetailResponseInfo

参数

参数类型

描述

id

String

参数解释：

白名单ID

取值范围：

字符长度0-64位

vul_id

String

参数解释：

漏洞ID（只在查询漏洞白名单时返回）

取值范围：

字符长度0-256位

vul_name

String

参数解释：

漏洞名称（只在查询漏洞白名单时返回）

取值范围：

字符长度0-256位

vul_type

String

参数解释：

漏洞类型（只在查询漏洞白名单时返回）

取值范围:

  • linux_vul：linux漏洞。

  • app_vul：应用漏洞。

cves

Array of cves objects

参数解释:

漏洞对应的CVE列表（只在查询漏洞白名单时返回）

取值范围:

最小值0，最大值1000

rule_type

String

白名单规则类型，包含如下：

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

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

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

query_info

query_info object

白名单规则为“specific_image_types”时，指定的镜像类型信息

image_info

Array of image_info objects

白名单规则为“specific_images”时，指定的镜像列表。只在查询镜像白名单详情时返回数据。

description

String

参数解释：

白名单的描述信息

取值范围：

字符长度0-1024位
表6 cves

参数

参数类型

描述

cve_id

String

参数解释:

CVE ID

取值范围:

字符长度0-256位

cvss

Float

参数解释:

CVE评分

取值范围:

取值0-10
表7 query_info

参数

参数类型

描述

image_type

String

参数解释：

镜像类型（多个类型用逗号间隔）

取值范围：

  • private_image：SWR私有镜像仓库。

  • shared_image：SWR共享镜像仓库。

  • instance_image：SWR企业仓库。

  • harbor：harbor仓库。

  • jfrog：jfrog仓库。
表8 image_info

参数

参数类型

描述

id

Long

参数解释：

仓库镜像ID

取值范围：

取值1-9223372036854775807

image_id

String

参数解释：

本地镜像ID

取值范围：

字符长度1-64位

image_name

String

参数解释：

镜像名称

取值范围：

字符长度1-256位

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "vul_id" : "CESA-2011:1777",
    "vul_name" : "EulerOS-SA-2020-1102 Moderate: glibc security update",
    "vul_type" : "linux_vul",
    "cves" : [ {
      "cve_id" : "KYSA-202201-0009",
      "cvss" : 7.9
    } ],
    "rule_type" : "specific_images",
    "query_info" : null,
    "image_info" : [ {
      "id" : 9223372036854776000,
      "image_name" : "image_name"
    } ],
    "description" : "some description"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 容器镜像

相关文档