文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 集群防护/ 获取所有集群中告警事件
更新时间:2025-08-15 GMT+08:00

获取所有集群中告警事件

功能介绍

获取所有集群中告警事件

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/cluster-protect/events

表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

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

cluster_id

String

集群ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

last_update_time

Long

最近更新时间

data_list

Array of ClusterEventResponseInfo objects

集群安全事件列表

表5 ClusterEventResponseInfo

参数

参数类型

描述

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

处理状态,包含如下:

  • unhandled:未处理

  • handled:已处理

create_time

Long

创建时间

update_time

Long

更新时间

project_id

String

项目ID

enterprise_project_id

String

企业ID

policy_name

String

策略名称

policy_id

String

策略ID

resource_info

ClusterEventResourceResponseInfo object

事件资源信息

表6 ClusterEventResourceResponseInfo

参数

参数类型

描述

enforcement_action

String

执行动作

group

String

Group

message

String

信息

name

String

名称

namespace

String

命名空间

version

String

版本

kind

String

资源类型

resource_name

String

资源名称

请求示例

获取所有集群中告警事件

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"
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListClusterEventsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListClusterEventsRequest request = new ListClusterEventsRequest();
        try {
            ListClusterEventsResponse response = client.listClusterEvents(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListClusterEventsRequest()
        response = client.list_cluster_events(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListClusterEventsRequest{}
	response, err := client.ListClusterEvents(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码