更新时间:2025-11-21 GMT+08:00
分享

列出告警规则 - ListAlertRules

功能介绍

列出告警规则

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目 ID

workspace_id

String

工作空间 ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

偏移量

limit

Long

条数

sort_key

String

排序字段

sort_dir

String

参数解释:

目录排序

  • asc 升序排列

  • desc 降序排列

约束限制

不涉及

取值范围:

  • asc

  • desc

默认值

不涉及

pipe_id

String

数据管道 ID

rule_name

String

告警规则名称

rule_id

String

告警规则 ID

status

Array of strings

参数解释:

状态

  • ENABLED 启用

  • DISABLED 禁用

约束限制

不涉及

取值范围:

  • ENABLED

  • DISABLED

默认值

不涉及

severity

Array of strings

参数解释:

告警等级

  • TIPS 提示

  • LOW 低危

  • MEDIUM 中危

  • HIGH 高危

  • FATAL 致命

约束限制

不涉及

取值范围:

  • TIPS

  • LOW

  • MEDIUM

  • HIGH

  • FATAL

默认值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

任务追踪请求ID

表5 响应Body参数

参数

参数类型

描述

count

Long

总数量

records

Array of AlertRule objects

告警模型

表6 AlertRule

参数

参数类型

描述

create_by

String

创建人

create_time

Long

创建时间

custom_properties

Map<String,String>

自定义扩展信息

delete_time

Long

删除时间

event_grouping

Boolean

告警分组

pipe_id

String

数据管道 ID

pipe_name

String

数据管道名称

query

String

查询语句

query_type

String

参数解释:

查询语法类型

  • SQL查询

  • SQL

约束限制:

不涉及

取值范围:

默认值:

SQL

rule_id

String

告警规则 ID

rule_name

String

告警规则名称

schedule

Schedule object

调度规则

severity

String

参数解释:

状态

  • TIPS 提示

  • LOW 低危

  • MEDIUM 中危

  • HIGH 高危

  • FATAL 致命

  • TIPS

  • LOW

  • MEDIUM

  • HIGH

  • FATAL

约束限制

不涉及

取值范围:

默认值

MEDIUM

status

String

参数解释:

状态

  • ENABLED 启用

  • DISABLED 禁用

约束限制

不涉及

取值范围:

  • ENABLED

  • DISABLED

默认值

不涉及

triggers

Array of AlertRuleTrigger objects

告警触发规则

update_by

String

更新人

update_time

Long

更新时间

表7 Schedule

参数

参数类型

描述

delay_interval

Integer

延迟间隔

frequency_interval

Integer

调度间隔

frequency_unit

String

参数解释:

调度间隔单位

  • MINUTE10 10分钟

  • HOUR 小时

  • DAY 天

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

默认值

不涉及

overtime_interval

Integer

超时间隔

period_interval

Integer

时间窗口间隔

period_unit

String

参数解释:

时间窗口单位

  • MINUTE10 10分钟

  • HOUR 小时

  • DAY 天

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

默认值

不涉及

表8 AlertRuleTrigger

参数

参数类型

描述

accumulated_times

Integer

累计次数

expression

String

表达式

mode

String

参数解释:

指标模式

  • COUNT 数量

约束限制

不涉及

取值范围:

  • COUNT

默认值

不涉及

operator

String

参数解释:

操作符类型

  • GT 大于

  • LT 小于

  • EQ 等于

  • NE 不等于

约束限制

不涉及

取值范围:

  • GT

  • LT

  • EQ

  • NE

默认值

不涉及

severity

String

参数解释:

告警等级

  • TIPS 提示

  • LOW 低危

  • MEDIUM 中危

  • HIGH 高危

  • FATAL 致命

约束限制

不涉及

取值范围:

  • TIPS

  • LOW

  • MEDIUM

  • HIGH

  • FATAL

默认值

不涉及

状态码:400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

任务追踪请求ID

请求示例

响应示例

状态码:200

成功

{
  "count" : 9223372036854776000,
  "records" : [ {
    "create_by" : "582dd19dd99d4505a1d7929dc943b169",
    "create_time" : 1665221214,
    "custom_properties" : {
      "maintainer" : "isap",
      "references" : "https://localhost/references"
    },
    "delete_time" : 0,
    "event_grouping" : true,
    "pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889",
    "query" : "* | select status, count(*) as count group by status",
    "query_type" : "SQL",
    "rule_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950",
    "rule_name" : "Alert rule",
    "schedule" : {
      "delay_interval" : 2,
      "frequency_interval" : 5,
      "frequency_unit" : "MINUTE",
      "overtime_interval" : 10,
      "period_interval" : 5,
      "period_unit" : "MINUTE"
    },
    "severity" : "TIPS",
    "status" : "ENABLED",
    "triggers" : [ {
      "expression" : 10,
      "mode" : "COUNT",
      "operator" : "GT",
      "severity" : "TIPS"
    } ],
    "update_by" : "582dd19dd99d4505a1d7929dc943b169",
    "update_time" : 1665221214
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

 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
48
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.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class ListAlertRulesSolution {

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

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAlertRulesRequest request = new ListAlertRulesRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListAlertRulesResponse response = client.listAlertRules(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAlertRulesRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_alert_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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 := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多

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

状态码

状态码

描述

200

成功

400

请求失败

错误码

请参见错误码

相关文档