获取所有集群中告警事件 - ListClusterEvents
功能介绍
获取所有集群中告警事件
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/cluster-protect/events
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
cluster_id |
否 |
String |
集群ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
总数 |
|
last_update_time |
Long |
最近更新时间 |
|
data_list |
Array of ClusterEventResponseInfo objects |
集群安全事件列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
action |
String |
阻断动作 |
|
cluster_name |
String |
集群名称 |
|
cluster_id |
String |
集群Id |
|
event_name |
String |
事件名称 |
|
event_class_id |
String |
事件唯一标识 |
|
event_id |
String |
事件id |
|
event_type |
Integer |
事件类型 |
|
event_content |
String |
事件内容 |
|
handle_status |
String |
处理状态,包含如下:
|
|
create_time |
Long |
创建时间 |
|
update_time |
Long |
更新时间 |
|
project_id |
String |
项目ID |
|
enterprise_project_id |
String |
企业ID |
|
policy_name |
String |
策略名称 |
|
policy_id |
String |
策略ID |
|
resource_info |
事件资源信息 |
请求示例
获取所有集群中告警事件
GET https://{endpoint}/v5/{project_id}/cluster-protect/events?offset=0&limit=200&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"total_num" : 2,
"data_list" : [ {
"projectId" : "84b5266c14ae489fa6549827f032dc62",
"enterpriseProjectId" : "0",
"action" : "warn",
"updateTime" : 1695094500324,
"event_id" : "03368dc5-80ae-482f-8fa8-e62d778bb29f",
"cluster_id" : "44753d6c-415e-11ee-834b-0255ac1001b2",
"event_class_id" : "clusterprotect_1001",
"event_type" : 3009,
"handle_status" : "unhandled",
"event_content" : "{\"enforcementAction\":\"warn\",\"group\":\"\",\"kind\":\"Pod\",\"message\":\"hit label a4, vul image nginx can not startup.\",\"name\":\"deny11\",\"namespace\":\"test-lby\",\"version\":\"v1\"}",
"policy_id" : "4636a2d6-1b8c-44d3-863d-7d881348d32a",
"policy_name" : "lbytest-warn",
"resource_info" : {
"enforcementAction" : "warn",
"group" : "",
"kind" : "Pod",
"message" : "hit label a4, vul image nginx can not startup.",
"name" : "deny11",
"namespace" : "test-lby",
"version" : "v1"
}
}, {
"projectId" : "84b5266c14ae489fa6549827f032dc62",
"enterpriseProjectId" : "0",
"action" : "warn",
"updateTime" : 1695094500324,
"event_id" : "cbbf88ab-385f-4ecc-a3b2-b933bdbd467f",
"cluster_id" : "44753d6c-415e-11ee-834b-0255ac1001b2",
"event_class_id" : "clusterprotect_1001",
"event_type" : 3009,
"handle_status" : "unhandled",
"event_content" : "{\"enforcementAction\":\"warn\",\"group\":\"\",\"kind\":\"Pod\",\"message\":\"hit label a4, vul image swr.cn-north-7.myhuaweicloud.com/scc_cgs_f00418753/nginx:test can not startup.\",\"name\":\"nginx-test-65d79f9d9f-jmmn4\",\"namespace\":\"default\",\"version\":\"v1\"}",
"policy_id" : "4636a2d6-1b8c-44d3-863d-7d881348d32a",
"policy_name" : "lbytest-warn",
"resource_info" : {
"enforcementAction" : "warn",
"group" : "",
"kind" : "Pod",
"message" : "hit label a4, vul image swr.cn-north-7.myhuaweicloud.com/scc_cgs_f00418753/nginx:test can not startup.",
"name" : "nginx-test-65d79f9d9f-jmmn4",
"namespace" : "default",
"version" : "v1"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。