更新时间:2024-11-20 GMT+08:00
分享

查询告警白名单列表

功能介绍

查询告警白名单列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/event/white-list/alarm

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,查询所有企业项目时填写:all_granted_eps

hash

String

事件白名单SHA256

event_type

Integer

事件类型,包含如下:

  • 1001 : 通用恶意软件

  • 1002 : 病毒

  • 1003 : 蠕虫

  • 1004 : 木马

  • 1005 : 僵尸网络

  • 1006 : 后门

  • 1010 : Rootkit

  • 1011 : 勒索软件

  • 1012 :黑客工具

  • 1015 : Webshell

  • 1016 : 挖矿

  • 1017 : 反弹Shell

  • 2001 : 一般漏洞利用

  • 2012 : 远程代码执行

  • 2047 : Redis漏洞利用

  • 2048 : Hadoop漏洞利用

  • 2049 : MySQL漏洞利用

  • 3002 : 文件提权

  • 3003 : 进程提权

  • 3004 : 关键文件变更

  • 3005 : 文件/目录变更

  • 3007 : 进程异常行为

  • 3015 : 高危命令执行

  • 3018 : 异常Shell

  • 3027 : Crontab可疑任务

  • 3029 :系统安全防护被禁用

  • 3030 :备份删除

  • 3031 :异常注册表操作

  • 3036 : 容器镜像阻断

  • 4002 : 暴力破解

  • 4004 : 异常登录

  • 4006 : 非法系统账号

  • 4014 : 用户账号添加

  • 4020 : 用户密码窃取

  • 6002 : 端口扫描

  • 6003 : 主机扫描

  • 13001 : Kubernetes事件删除

  • 13002 : Pod异常行为

  • 13003 : 枚举用户信息

  • 13004 : 绑定集群用户角色

offset

Integer

偏移量:指定返回记录的开始位置

limit

Integer

每页显示个数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

region

String

Region ID

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

event_type_list

Array of integers

支持筛选的事件类型

data_list

Array of AlarmWhiteListResponseInfo objects

告警白名单详情

表5 AlarmWhiteListResponseInfo

参数

参数类型

描述

enterprise_project_name

String

企业项目名称

hash

String

事件白名单SHA256

description

String

描述信息

event_type

Integer

事件类型,包含如下:

  • 1001 : 通用恶意软件

  • 1002 : 病毒

  • 1003 : 蠕虫

  • 1004 : 木马

  • 1005 : 僵尸网络

  • 1006 : 后门

  • 1010 : Rootkit

  • 1011 : 勒索软件

  • 1012 :黑客工具

  • 1015 : Webshell

  • 1016 : 挖矿

  • 1017 : 反弹Shell

  • 2001 : 一般漏洞利用

  • 2012 : 远程代码执行

  • 2047 : Redis漏洞利用

  • 2048 : Hadoop漏洞利用

  • 2049 : MySQL漏洞利用

  • 3002 : 文件提权

  • 3003 : 进程提权

  • 3004 : 关键文件变更

  • 3005 : 文件/目录变更

  • 3007 : 进程异常行为

  • 3015 : 高危命令执行

  • 3018 : 异常Shell

  • 3027 : Crontab可疑任务

  • 3029 :系统安全防护被禁用

  • 3030 :备份删除

  • 3031 :异常注册表操作

  • 3036 : 容器镜像阻断

  • 4002 : 暴力破解

  • 4004 : 异常登录

  • 4006 : 非法系统账号

  • 4014 : 用户账号添加

  • 4020 : 用户密码窃取

  • 6002 : 端口扫描

  • 6003 : 主机扫描

  • 13001 : Kubernetes事件删除

  • 13002 : Pod异常行为

  • 13003 : 枚举用户信息

  • 13004 : 绑定集群用户角色

white_field

String

加白字段,包含如下:

  • "file/process hash" # 进程/文件hash

  • "file_path" # 文件路径

  • "process_path" # 进程路径

  • "login_ip" # 登录ip

  • "reg_key" #注册表key

  • "process_cmdline" # 进程命令行

  • "username" # 用户名

field_value

String

加白字段值

judge_type

String

通配符,包含如下:

  • "equal" # 相等

  • "contain" # 包含

update_time

Long

事件白名单更新时间,毫秒

请求示例

查询前10条企业项目为xxx下的告警白名单列表

GET https://{endpoint}/v5/{project_id}/event/white-list/alarm?limit=10&offset=0&enterprise_project_id=xxx

响应示例

状态码: 200

告警白名单列表

{
  "data_list" : [ {
    "enterprise_project_name" : "所有项目",
    "event_type" : 1001,
    "hash" : "9ab079e5398cba3a368ccffbd478f54c5ec3edadf6284ec049a73c36419f1178",
    "description" : "/opt/cloud/3rdComponent/install/jre-8u201/bin/java",
    "update_time" : 1665715677307,
    "white_field" : "process/file hash",
    "judge_type" : "contain",
    "field_value" : "abcd12345612311112212323"
  } ],
  "event_type_list" : [ 1001 ],
  "total_num" : 1
}

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 ListAlarmWhiteListSolution {

    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();
        ListAlarmWhiteListRequest request = new ListAlarmWhiteListRequest();
        try {
            ListAlarmWhiteListResponse response = client.listAlarmWhiteList(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 = ListAlarmWhiteListRequest()
        response = client.list_alarm_white_list(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.ListAlarmWhiteListRequest{}
	response, err := client.ListAlarmWhiteList(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

告警白名单列表

错误码

请参见错误码

相关文档