更新时间:2025-08-20 GMT+08:00

创建关键词告警规则

功能介绍

该接口用于创建关键词告警,目前每个账户最多可以创建共200个关键词告警与SQL告警。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/lts/alarms/keywords-alarm-rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

keywords_alarm_rule_name

String

参数解释:

关键词告警规则名称。

约束限制:

支持修改规则名称,不支持修改首次创建的原始名称。

取值范围:

  • 支持输入英文、数字、中文、中划线、下划线,且不能以中划线、下划线开头或结尾。

  • 最大长度不超过128个字符。

默认取值:

不涉及

keywords_alarm_rule_description

String

参数解释:

关键词告警规则的简要描述。

约束限制:

不涉及。

取值范围:

长度不能超过128个字符。

默认取值:

不涉及。

keywords_requests

Array of KeywordsRequest objects

参数解释:

关键词告警规则信息。

约束限制:

不涉及。

frequency

Frequency object

参数解释:

关键词告警统计周期信息。

约束限制:

不涉及。

keywords_alarm_level

String

参数解释:

关键词告警级别。

约束限制:

不涉及。

取值范围:

  • Info:提示

  • Minor:次要

  • Major:重要

  • Critical:紧急

默认取值:

不涉及。

domain_id

String

参数解释:

账号ID,获取方式请参见:获取账号ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

trigger_condition_count

Integer

参数解释:

告警触发条件:满足条件次数。满足条件次数是指设置的关键词。

在统计周期次数内且满足条件次数时,可触发关键词告警。

约束限制:

  • trigger_condition_count和trigger_condition_frequency需同时配置才能触发关键词告警。

  • 配置的统计周期次数须大于等于满足触发条件次数。

取值范围:

不涉及。

默认取值:

不涉及。

trigger_condition_frequency

Integer

参数解释:

告警触发条件:统计周期次数。统计周期次数指高级设置的统计周期。

当在统计周期次数内且满足条件次数时,可触发关键词告警。

约束限制:

  • trigger_condition_count和trigger_condition_frequency需同时配置才能触发关键词告警。

  • 配置的统计周期次数须大于等于满足触发条件次数。

取值范围:

最小值为1

最大值为10

默认取值:

不涉及。

whether_recovery_policy

Boolean

参数解释:

是否配置告警恢复策略。满足该策略时,会发送告警恢复通知。

约束限制:

不涉及。

取值范围:

  • true:配置告警恢复策略。

  • false:不配置告警恢复策略。

默认取值:

false

recovery_policy

Integer

参数解释:

告警恢复策略周期次数。

配置的最近统计周期次数内,如果不满足触发条件且开启恢复时通知开关,则会发送恢复告警通知。

约束限制:

不涉及。

取值范围:

  • 最小值为1

  • 最大值为10

默认取值:

不涉及。

notification_frequency

Integer

参数解释:

告警通知频率。有立即通知、每5分钟、每10分钟、每15分钟、每30分钟、每1小时、每3小时、每6小时。

其中,立即通知指只要产生告警就发送通知,每10分钟指的是两次通知之间最小时间间隔为10分钟,可避免告警轰炸。

约束限制:

不涉及。

取值范围:

  • 0

  • 5

  • 10

  • 15

  • 30

  • 60

  • 180

  • 630

默认取值:

不涉及。

alarm_action_rule_name

String

参数解释:

告警行动规则名称。

约束限制:

不涉及。

取值范围:

  • 支持输入英文、数字、中文、中划线、下划线,且不能以中划线、下划线开头或结尾。

  • 最大长度不超过128个字符。

默认取值:

不涉及。

tags

Array of tagsRequestBody objects

参数解释:

告警标签信息。标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

约束限制:

不涉及。

表4 KeywordsRequest

参数

是否必选

参数类型

描述

log_stream_id

String

参数解释:

日志流ID,获取方式请参见:获取日志组ID和日志流ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

log_stream_name

String

参数解释:

日志流名称。

当日志组下有多个日志流时,支持选择多个日志流,即可批量创建关键词告警。

约束限制:

  • 只支持输入英文、数字、中文、中划线、下划线及小数点,且不能以小数点、下划线开头或以小数点结尾。

  • 长度为1-64个字符。

取值范围:

不涉及。

默认取值:

不涉及。

log_group_id

String

参数解释:

日志流ID,获取方式请参见:获取日志组ID和日志流ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

log_group_name

String

参数解释:

日志组名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

keywords

String

参数解释:

在日志搜索能查到的日志关键字。关键词支持精确匹配和模糊匹配,输入长度不超过1024个字符。如何设置关键词搜索请参考搜索语法介绍

约束限制:

不涉及。

取值范围:

长度不能超过1024个字符。

默认取值:

不涉及。

condition

String

参数解释:

触发条件,即满足该条件时,会触发告警。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

number

Integer

参数解释:

匹配条数。当关键词搜索结果的日志条数达到设定的条数时,会触发告警。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

search_time_range

Integer

参数解释:

查询执行告警任务时最近数据的时间范围。

约束限制:

  • 当search_time_range_unit为minute,则最大值为60。

  • 当search_time_range_unit为hour,则最大值为24。

取值范围:

最小值:1

最大值:60

默认取值:

1

search_time_range_unit

String

参数解释:

查询告警时间范围单位。

约束限制:

不涉及。

取值范围:

  • minute

  • hour

默认取值:

minute

表5 Frequency

参数

是否必选

参数类型

描述

type

String

参数解释:

告警统计周期类型。

约束限制:

不涉及。

取值范围:

  • CRON:cron表达式

  • HOURLY:每小时

  • DAILY:每天

  • WEEKLY:每周

  • FIXED_RATE:固定间隔

默认取值:

不涉及。

cron_expr

String

参数解释:

CRON表达式。当type取值为CRON时,填写该字段。CRON最小精度为分钟,格式为24小时制。例如:

  • 0/9 * * * * 从每小时的第0分钟开始,每9分钟执行一次。

  • 0 18 * * * 每天18点0分发送一次。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

hour_of_day

Integer

参数解释:

每天每小时。当type取值为DAILY或HOURLY时,填写该字段。

约束限制:

不涉及。

取值范围:

DAILY:00:00~23:00

默认取值:

不涉及。

day_of_week

Integer

参数解释:

每周。当type取值为WEEKLY时,填写该字段。

约束限制:

不涉及。

取值范围:

周日~周六 00:00~23:00

默认取值:

不涉及。

fixed_rate

Integer

参数解释:

固定间隔。当type取值为FIXED_RATE时,填写该字段。

约束限制:

不涉及。

取值范围:

  • 当fixed_rate_unit(固定间隔时间单位)为minute,最大值为60。

  • 当fixed_rate_unit(固定间隔时间单位)为hour,最大值24。

默认取值:

不涉及。

fixed_rate_unit

String

参数解释:

固定间隔时间单位。

约束限制:

不涉及。

取值范围:

  • minute

  • hour

默认取值:

不涉及。

表6 tagsRequestBody

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键。

约束限制:

  • 标签键名称不可重复。

  • 标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

取值范围:

标签键可以包含任意语种的字母、数字和空格,以及_.:=+-@字符,但首尾不能包含空格,且不能以_sys_开头;长度不能超过128个字符。

默认取值:

不涉及。

value

String

参数解释:

标签值。

约束限制:

标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

取值范围:

  • 标签值可以包含任意语种的字母、数字和空格,以及_.:=+-@字符。

  • 标签值长度不能超过255个字符。

默认取值:

不涉及。

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

keywords_alarm_rule_id

String

参数解释:

关键词告警规则ID。

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

请求示例

创建关键词告警规则。

POST https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule 

{
  "keywords_alarm_rule_name" : "huawei",
  "keywords_alarm_rule_description" : "huawei",
  "keywords_requests" : [ {
    "log_stream_id" : "1",
    "log_group_id" : "1",
    "keywords" : "huawei",
    "condition" : ">",
    "number" : "100",
    "search_time_range" : 10,
    "search_time_range_unit" : "minute"
  } ],
  "frequency" : {
    "type" : "FIXED_RATE",
    "cron_expr" : "",
    "hour_of_day" : 0,
    "day_of_week" : 0,
    "fixed_rate" : 10,
    "fixed_rate_unit" : "minute"
  },
  "keywords_alarm_level" : "Critical",
  "domain_id" : "",
  "notification_frequency" : 5,
  "alarm_action_rule_name" : ""
}

响应示例

状态码:200

请求响应成功。

{
  "keywords_alarm_rule_id" : ""
}

状态码:400

非法请求,建议根据error_msg直接修改该请求。

{
  "error_code" : "LTS.2005",
  "error_msg" : "Alarm rule params validator error."
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错。

{
  "error_code" : "LTS.2001",
  "error_msg" : "Failed to create alarm rule."
}

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateKeywordsAlarmRuleSolution {

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

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateKeywordsAlarmRuleRequest request = new CreateKeywordsAlarmRuleRequest();
        CreateKeywordsAlarmRuleRequestBody body = new CreateKeywordsAlarmRuleRequestBody();
        Frequency frequencybody = new Frequency();
        frequencybody.withType(Frequency.TypeEnum.fromValue("FIXED_RATE"))
            .withCronExpr("")
            .withHourOfDay(0)
            .withDayOfWeek(0)
            .withFixedRate(10)
            .withFixedRateUnit(Frequency.FixedRateUnitEnum.fromValue("minute"));
        List<KeywordsRequest> listbodyKeywordsRequests = new ArrayList<>();
        listbodyKeywordsRequests.add(
            new KeywordsRequest()
                .withLogStreamId("1")
                .withLogGroupId("1")
                .withKeywords("huawei")
                .withCondition(KeywordsRequest.ConditionEnum.fromValue(">"))
                .withNumber(100)
                .withSearchTimeRange(10)
                .withSearchTimeRangeUnit(KeywordsRequest.SearchTimeRangeUnitEnum.fromValue("minute"))
        );
        body.withAlarmActionRuleName("");
        body.withNotificationFrequency(CreateKeywordsAlarmRuleRequestBody.NotificationFrequencyEnum.NUMBER_5);
        body.withDomainId("");
        body.withKeywordsAlarmLevel(CreateKeywordsAlarmRuleRequestBody.KeywordsAlarmLevelEnum.fromValue("Critical"));
        body.withFrequency(frequencybody);
        body.withKeywordsRequests(listbodyKeywordsRequests);
        body.withKeywordsAlarmRuleDescription("huawei");
        body.withKeywordsAlarmRuleName("huawei");
        request.withBody(body);
        try {
            CreateKeywordsAlarmRuleResponse response = client.createKeywordsAlarmRule(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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateKeywordsAlarmRuleRequest()
        frequencybody = Frequency(
            type="FIXED_RATE",
            cron_expr="",
            hour_of_day=0,
            day_of_week=0,
            fixed_rate=10,
            fixed_rate_unit="minute"
        )
        listKeywordsRequestsbody = [
            KeywordsRequest(
                log_stream_id="1",
                log_group_id="1",
                keywords="huawei",
                condition=">",
                number=100,
                search_time_range=10,
                search_time_range_unit="minute"
            )
        ]
        request.body = CreateKeywordsAlarmRuleRequestBody(
            alarm_action_rule_name="",
            notification_frequency=5,
            domain_id="",
            keywords_alarm_level="Critical",
            frequency=frequencybody,
            keywords_requests=listKeywordsRequestsbody,
            keywords_alarm_rule_description="huawei",
            keywords_alarm_rule_name="huawei"
        )
        response = client.create_keywords_alarm_rule(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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
package main

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

    request := &model.CreateKeywordsAlarmRuleRequest{}
	cronExprFrequency:= ""
	hourOfDayFrequency:= int32(0)
	dayOfWeekFrequency:= int32(0)
	fixedRateFrequency:= int32(10)
	fixedRateUnitFrequency:= model.GetFrequencyFixedRateUnitEnum().MINUTE
	frequencybody := &model.Frequency{
		Type: model.GetFrequencyTypeEnum().FIXED_RATE,
		CronExpr: &cronExprFrequency,
		HourOfDay: &hourOfDayFrequency,
		DayOfWeek: &dayOfWeekFrequency,
		FixedRate: &fixedRateFrequency,
		FixedRateUnit: &fixedRateUnitFrequency,
	}
	var listKeywordsRequestsbody = []model.KeywordsRequest{
        {
            LogStreamId: "1",
            LogGroupId: "1",
            Keywords: "huawei",
            Condition: model.GetKeywordsRequestConditionEnum().GREATER_THAN,
            Number: int32(100),
            SearchTimeRange: int32(10),
            SearchTimeRangeUnit: model.GetKeywordsRequestSearchTimeRangeUnitEnum().MINUTE,
        },
    }
	alarmActionRuleNameCreateKeywordsAlarmRuleRequestBody:= ""
	keywordsAlarmRuleDescriptionCreateKeywordsAlarmRuleRequestBody:= "huawei"
	request.Body = &model.CreateKeywordsAlarmRuleRequestBody{
		AlarmActionRuleName: &alarmActionRuleNameCreateKeywordsAlarmRuleRequestBody,
		NotificationFrequency: model.GetCreateKeywordsAlarmRuleRequestBodyNotificationFrequencyEnum().E_5,
		DomainId: "",
		KeywordsAlarmLevel: model.GetCreateKeywordsAlarmRuleRequestBodyKeywordsAlarmLevelEnum().CRITICAL,
		Frequency: frequencybody,
		KeywordsRequests: listKeywordsRequestsbody,
		KeywordsAlarmRuleDescription: &keywordsAlarmRuleDescriptionCreateKeywordsAlarmRuleRequestBody,
		KeywordsAlarmRuleName: "huawei",
	}
	response, err := client.CreateKeywordsAlarmRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求响应成功。

400

非法请求,建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码