查询集群风险列表 - ListClusterRisks
功能介绍
查询集群风险列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/container/cluster/risks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
risk_type |
否 |
String |
风险类型,包含如下
|
|
risk_status |
否 |
String |
风险状态,包含如下,该字段不传值则查询全部数据:
|
|
cluster_id |
否 |
String |
集群id |
|
cluster_name |
否 |
String |
集群名称 |
|
risk_name |
否 |
String |
风险名称 |
|
risk_level |
否 |
String |
风险程度,包含如下
|
|
risk_category |
否 |
String |
风险分类,包含如下:
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
集群风险列表数量 |
|
data_list |
Array of data_list objects |
集群风险列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
risk_id |
String |
风险id |
|
risk_name |
String |
风险名称 |
|
cluster_id |
String |
集群id |
|
cluster_name |
String |
集群名称 |
|
risk_level |
String |
风险程度,包含如下
|
|
risk_category |
String |
风险分类,包含如下:
|
|
risk_num |
Integer |
风险数量 |
|
last_scan_time |
Long |
最近一次扫描时间 |
|
description |
String |
风险描述 |
|
remediation |
String |
风险的处置建议 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"risk_id" : "C-0035",
"risk_name" : "RBAC enabled",
"cluster_id" : "4axxxxf3-6xxc-4xxc-9xx3-099xxxxxx4c2",
"cluster_name" : "my-cluster",
"risk_level" : "high",
"risk_category" : "access_control",
"risk_num" : 7,
"last_scan_time" : 1745311451000,
"description" : "some risk description.",
"remediation" : "some risk remediation."
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。