文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 集群管理/ 批量获取容器集群风险信息 - ListCceClusterDetectRisk
更新时间:2025-10-31 GMT+08:00
分享

批量获取容器集群风险信息 - ListCceClusterDetectRisk

功能介绍

批量获取容器集群风险信息

授权信息

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

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

URI

POST /v5/{project_id}/container/kubernetes/clusters/risks/query

表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参数

参数

是否必选

参数类型

描述

cluster_id_list

Array of strings

集群id列表

detect_type

String

查询类型,包含如下:

- image : 镜像风险

- baseline : 基线风险

- vul : 漏洞风险

- event : 入侵风险

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

total_num

Integer

集群总数

data_list

Array of NodeDetectRiskResponseInfo objects

集群信息列表

表6 NodeDetectRiskResponseInfo

参数

参数类型

描述

images_num

Integer

有风险镜像数量

baseline_risk_num

Integer

基线检查风险项总和

vul_num

Integer

漏洞数量

event_num

Integer

告警数量

protect_node_num

Integer

集群开启防护节点数量

node_total_num

Integer

集群节点总数

cluster_id

String

集群id

charging_mode

String

付费模式包括:

  • on_demand:按需

  • free:免费

请求示例

批量获取容器集群风险信息

POST https://{endpoint}/v5/{project_id}/container/kubernetes/clusters/risks/query?enterprise_project_id=all_granted_eps

{
  "cluster_id_list" : [ "46XXXXX8-bf45-425a-80fc-f41XXXXXb130" ]
}

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "cluster_id" : "bXXb-d21a-499a-9006-6240XXXX4402",
    "charging_mode" : "free",
    "node_total_num" : 50,
    "protect_node_num" : 25,
    "event_num" : 1000,
    "vul_num" : 15,
    "baseline_risk_num" : 1015,
    "images_num" : 10
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档