Updated on 2025-08-15 GMT+08:00

Obtaining Alarm Events in All Clusters

Function

This API is used to obtain alarm events in all clusters.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

Yes

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

N/A

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

cluster_id

No

String

Specifies the cluster ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

last_update_time

Long

Updated

data_list

Array of ClusterEventResponseInfo objects

Cluster security event list

Table 5 ClusterEventResponseInfo

Parameter

Type

Description

action

String

Blocking action.

cluster_name

String

Cluster name

cluster_id

String

Cluster ID

event_name

String

Event name

event_class_id

String

Unique event ID.

event_id

String

Incident ID.

event_type

Integer

Event type.

event_content

String

Event content

handle_status

String

Handling status. It can be:

  • unhandled

  • handled

create_time

Long

Creation time

update_time

Long

Update time

project_id

String

The project ID.

enterprise_project_id

String

Enterprise ID.

policy_name

String

Policy name

policy_id

String

Policy ID

resource_info

ClusterEventResourceResponseInfo object

Event resource information

Table 6 ClusterEventResourceResponseInfo

Parameter

Type

Description

enforcement_action

String

Execution actions

group

String

Group

message

String

Information

name

String

Name

namespace

String

Namespaces

version

String

Version

kind

String

Resource type

resource_name

String

Resource name.

Example Requests

Obtain the alarm events in all clusters.

GET https://{endpoint}/v5/{project_id}/cluster-protect/events?offset=0&limit=200&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.