更新时间:2024-12-20 GMT+08:00

创建关键词告警规则

功能介绍

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

keywords_alarm_rule_name

String

关键词告警名称

说明:

不能以点和下划线开头或以点结尾。

最小长度:1

最大长度:64

keywords_alarm_rule_description

String

关键词告警信息描述

最小长度:0

最大长度:64

keywords_requests

Array of KeywordsRequest objects

关键词详细信息

frequency

Frequency object

告警统计周期

keywords_alarm_level

String

告警级别

keywords_alarm_send

Boolean

是否发送

domain_id

String

domainId

最小长度:32

最大长度:32

notification_save_rule

SqlNotificationSaveRule object

通知主题

trigger_condition_count

Integer

触发条件:触发次数;默认为1

trigger_condition_frequency

Integer

触发条件:触发周期;默认为1

whether_recovery_policy

Boolean

是否打开恢复通知;默认false

recovery_policy

Integer

恢复策略周期;默认为3

notification_frequency

Integer

通知频率,单位(分钟)

alarm_action_rule_name

String

告警行动规则名称

说明:

alarm_action_rule_name和notification_save_rule可以选填一个,如果都填,优先选择alarm_action_rule_name

表4 KeywordsRequest

参数

是否必选

参数类型

描述

log_stream_id

String

日志流id

最小长度:36

最大长度:36

log_stream_name

String

日志流名称

最小长度:1

最大长度:64

log_group_id

String

日志组id

最小长度:36

最大长度:36

log_group_name

String

日志组名称

最小长度:1

最大长度:64

keywords

String

关键词

最小长度:1

最大长度:1024

condition

String

条件

number

Integer

行数

最小值:1

最大值:2147483647

search_time_range

Integer

查询执行任务时最近数据的时间范围,最大值为60 minute:最小值:1;最大值:60 hour:最小值:1;最大值:24

search_time_range_unit

String

查询时间单位

表5 Frequency

参数

是否必选

参数类型

描述

type

String

时间类型。

cron_expr

String

当字段type为"CRON"时取该字段。

最小长度:1

最大长度:1024

hour_of_day

Integer

当字段type为"DAILY"或者"WEEKLY"时取该字段。

DAILY:最小值:0,最大值:23

WEEKLY:最小值:0,最大值:23

day_of_week

Integer

当字段type为"WEEKLY"时取该字段(周日~周六)。

最小值:1

最大值:7

fixed_rate

Integer

当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24,最小值5)。

最小值:1

最大值:60

fixed_rate_unit

String

时间单位。

表6 SqlNotificationSaveRule

参数

是否必选

参数类型

描述

language

String

首选项对应的语言

最小长度:0

最大长度:10

timezone

String

首选项对应的时区信息

最小长度:0

最大长度:1024

user_name

String

用户名

最小长度:1

最大长度:1024

topics

Array of Topics objects

主题信息

template_name

String

消息模板名称

表7 Topics

参数

是否必选

参数类型

描述

name

String

主题名称。

最小长度:1

最大长度:1024

topic_urn

String

Topic的唯一的资源标识。

最小长度:1

最大长度:1024

display_name

String

Topic的显示名,推送邮件消息时,作为邮件发件人显示。

最小长度:1

最大长度:1024

push_policy

Integer

消息推送的策略。

最小值:1

最大值:1024

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

keywords_alarm_rule_id

String

告警规则id

最小长度:36

最大长度:36

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码: 500

表10 响应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",
  "keywords_alarm_send" : true,
  "domain_id" : "",
  "notification_frequency" : 5,
  "alarm_action_rule_name" : "",
  "notification_save_rule" : {
    "language" : "zh-cn",
    "timezone" : "Asia/Shanghai",
    "user_name" : "huawei",
    "template_name" : "消息模板名称",
    "topics" : [ {
      "name" : "huawei",
      "topic_urn" : "urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei",
      "display_name" : "",
      "push_policy" : 0
    } ]
  }
}

响应示例

状态码: 200

请求响应成功。

{
  "keywords_alarm_rule_id" : ""
}

状态码: 400

BadRequest 非法请求 建议根据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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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();
        List<Topics> listNotificationSaveRuleTopics = new ArrayList<>();
        listNotificationSaveRuleTopics.add(
            new Topics()
                .withName("huawei")
                .withTopicUrn("urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei")
                .withDisplayName("")
                .withPushPolicy(0)
        );
        SqlNotificationSaveRule notificationSaveRulebody = new SqlNotificationSaveRule();
        notificationSaveRulebody.withLanguage(SqlNotificationSaveRule.LanguageEnum.fromValue("zh-cn"))
            .withTimezone("Asia/Shanghai")
            .withUserName("huawei")
            .withTopics(listNotificationSaveRuleTopics)
            .withTemplateName("消息模板名称");
        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.withNotificationSaveRule(notificationSaveRulebody);
        body.withDomainId("");
        body.withKeywordsAlarmSend(true);
        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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# 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()
        listTopicsNotificationSaveRule = [
            Topics(
                name="huawei",
                topic_urn="urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei",
                display_name="",
                push_policy=0
            )
        ]
        notificationSaveRulebody = SqlNotificationSaveRule(
            language="zh-cn",
            timezone="Asia/Shanghai",
            user_name="huawei",
            topics=listTopicsNotificationSaveRule,
            template_name="消息模板名称"
        )
        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,
            notification_save_rule=notificationSaveRulebody,
            domain_id="",
            keywords_alarm_send=True,
            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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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{}
	displayNameTopics:= ""
	pushPolicyTopics:= int32(0)
	var listTopicsNotificationSaveRule = []model.Topics{
        {
            Name: "huawei",
            TopicUrn: "urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei",
            DisplayName: &displayNameTopics,
            PushPolicy: &pushPolicyTopics,
        },
    }
	timezoneNotificationSaveRule:= "Asia/Shanghai"
	notificationSaveRulebody := &model.SqlNotificationSaveRule{
		Language: model.GetSqlNotificationSaveRuleLanguageEnum().ZH_CN,
		Timezone: &timezoneNotificationSaveRule,
		UserName: "huawei",
		Topics: listTopicsNotificationSaveRule,
		TemplateName: "消息模板名称",
	}
	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,
		NotificationSaveRule: notificationSaveRulebody,
		DomainId: "",
		KeywordsAlarmSend: true,
		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

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

500

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

错误码

请参见错误码