修改关键词告警规则
功能介绍
该接口用于修改关键词告警。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/lts/alarms/keywords-alarm-rule
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
keywords_alarm_rule_id |
是 |
String |
关键词告警规则id |
keywords_alarm_rule_name |
是 |
String |
规则原始名称(不支持修改首次创建的原始名称) |
alarm_rule_alias |
否 |
String |
规则名称 |
keywords_alarm_rule_description |
否 |
String |
关键词告警信息描述 |
keywords_requests |
是 |
Array of KeywordsRequest objects |
关键词详细信息 |
frequency |
是 |
Frequency object |
告警统计周期 |
keywords_alarm_level |
是 |
String |
告警级别 |
keywords_alarm_send |
是 |
Boolean |
是否发送 |
keywords_alarm_send_code |
是 |
Integer |
发送主题 0:不变 1:新增 2:修改 3:删除 |
domain_id |
是 |
String |
domainId |
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 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
log_stream_id |
是 |
String |
日志流id |
log_stream_name |
否 |
String |
日志流名称 |
log_group_id |
是 |
String |
日志组id |
log_group_name |
否 |
String |
日志组名称 |
keywords |
是 |
String |
关键词 |
condition |
是 |
String |
条件 |
number |
是 |
Integer |
行数 |
search_time_range |
是 |
Integer |
查询执行任务时最近数据的时间范围,最大值为60 minute:最小值:1;最大值:60 hour:最小值:1;最大值:24 |
search_time_range_unit |
是 |
String |
查询时间单位 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
时间类型。 |
cron_expr |
否 |
String |
当字段type为"CRON"时取该字段。 |
hour_of_day |
否 |
Integer |
当字段type为"DAILY"或者"WEEKLY"时取该字段。 DAILY:最小值:0,最大值:23 WEEKLY:最小值:0,最大值:23 |
day_of_week |
否 |
Integer |
当字段type为"WEEKLY"时取该字段(周日~周六)。 |
fixed_rate |
否 |
Integer |
当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24,最小值5)。 |
fixed_rate_unit |
否 |
String |
时间单位。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
language |
是 |
String |
首选项对应的语言 |
timezone |
否 |
String |
首选项对应的时区信息 |
user_name |
是 |
String |
用户名 |
topics |
是 |
Array of Topics objects |
主题信息 |
template_name |
是 |
String |
消息模板名称 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
keywords_alarm_rule_id |
String |
关键词告警id |
keywords_alarm_rule_name |
String |
原始规则名称 |
alarm_rule_alias |
String |
规则名称 |
keywords_alarm_rule_description |
String |
关键词告警信息描述 |
keywords_requests |
Array of KeywordsResBody objects |
关键词详细信息 |
frequency |
FrequencyRespBody object |
告警统计周期 |
keywords_alarm_level |
String |
告警级别 |
keywords_alarm_send |
Boolean |
是否发送 |
domain_id |
String |
domainId |
create_time |
Long |
创建时间(毫秒时间戳) |
update_time |
Long |
更新时间(毫秒时间戳) |
language |
String |
邮件附加信息语言 |
projectId |
String |
项目id |
topics |
Array of Topics objects |
通知主题 |
condition_expression |
String |
情况表述 |
indexId |
String |
索引id |
notification_frequency |
Integer |
通知频率,单位(分钟) |
alarm_action_rule_name |
String |
告警行动规则名称
说明:
alarm_action_rule_name和notification_save_rule可以选填一个,如果都填,优先选择alarm_action_rule_name |
参数 |
参数类型 |
描述 |
---|---|---|
log_stream_id |
String |
日志流id |
log_stream_name |
String |
日志流名称 |
log_group_id |
String |
日志组id |
log_group_name |
String |
日志组名称 |
keywords |
String |
关键词 |
condition |
String |
条件 |
number |
Integer |
行数 |
search_time_range |
Integer |
查询执行任务时最近数据的时间范围,最大值为60 |
search_time_range_unit |
String |
查询时间单位 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
时间类型。 |
cron_expr |
String |
当字段type为"CRON"时取该字段。 |
hour_of_day |
Integer |
当字段type为"DAILY"或者"WEEKLY"时取该字段。 |
day_of_week |
Integer |
当字段type为"WEEKLY"时取该字段(周日~周六)。 |
fixed_rate |
Integer |
当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24)。 |
fixed_rate_unit |
String |
时间单位枚举值: |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
主题名称。 |
topic_urn |
String |
Topic的唯一的资源标识。 |
display_name |
String |
Topic的显示名,推送邮件消息时,作为邮件发件人显示。 |
push_policy |
Integer |
消息推送的策略。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
请求示例
修改关键词告警规则
PUT https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule { "keywords_alarm_rule_id" : "", "keywords_alarm_rule_name" : "huawei", "alarm_rule_alias" : "zhangsan", "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, "keywords_alarm_send_code" : "2", "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" : "", "keywords_alarm_rule_name" : "huawei", "keywords_alarm_rule_description" : "huawei", "alarm_rule_alias" : "zhangsan", "keywords_requests" : [ { "log_stream_id" : "1", "log_stream_name" : "huawei", "log_group_name" : "huawei", "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" : false, "domain_id" : "", "notification_frequency" : 5, "alarm_action_rule_name" : "", "topics" : [ { "name" : "huawei", "topic_urn" : "urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei", "display_name" : "", "push_policy" : 0 } ], "language" : "zh-cn" }
状态码: 400
BadRequest 非法请求 建议根据error_msg直接修改该请求。
{ "error_code" : "LTS.2005", "error_msg" : "Alarm rule params validator error." }
状态码: 500
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.2003", "error_msg" : "Failed to update 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 94 95 96 |
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 UpdateKeywordsAlarmRuleSolution { 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(); UpdateKeywordsAlarmRuleRequest request = new UpdateKeywordsAlarmRuleRequest(); UpdateKeywordsAlarmRuleRequestBody body = new UpdateKeywordsAlarmRuleRequestBody(); 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(UpdateKeywordsAlarmRuleRequestBody.NotificationFrequencyEnum.NUMBER_5); body.withNotificationSaveRule(notificationSaveRulebody); body.withDomainId(""); body.withKeywordsAlarmSendCode(UpdateKeywordsAlarmRuleRequestBody.KeywordsAlarmSendCodeEnum.NUMBER_2); body.withKeywordsAlarmSend(true); body.withKeywordsAlarmLevel(UpdateKeywordsAlarmRuleRequestBody.KeywordsAlarmLevelEnum.fromValue("Critical")); body.withFrequency(frequencybody); body.withKeywordsRequests(listbodyKeywordsRequests); body.withKeywordsAlarmRuleDescription("huawei"); body.withAlarmRuleAlias("zhangsan"); body.withKeywordsAlarmRuleName("huawei"); body.withKeywordsAlarmRuleId(""); request.withBody(body); try { UpdateKeywordsAlarmRuleResponse response = client.updateKeywordsAlarmRule(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 78 79 80 |
# 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 = UpdateKeywordsAlarmRuleRequest() 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 = UpdateKeywordsAlarmRuleRequestBody( alarm_action_rule_name="", notification_frequency=5, notification_save_rule=notificationSaveRulebody, domain_id="", keywords_alarm_send_code=2, keywords_alarm_send=True, keywords_alarm_level="Critical", frequency=frequencybody, keywords_requests=listKeywordsRequestsbody, keywords_alarm_rule_description="huawei", alarm_rule_alias="zhangsan", keywords_alarm_rule_name="huawei", keywords_alarm_rule_id="" ) response = client.update_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 94 95 96 97 |
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.UpdateKeywordsAlarmRuleRequest{} 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, }, } alarmActionRuleNameUpdateKeywordsAlarmRuleRequestBody:= "" keywordsAlarmRuleDescriptionUpdateKeywordsAlarmRuleRequestBody:= "huawei" alarmRuleAliasUpdateKeywordsAlarmRuleRequestBody:= "zhangsan" request.Body = &model.UpdateKeywordsAlarmRuleRequestBody{ AlarmActionRuleName: &alarmActionRuleNameUpdateKeywordsAlarmRuleRequestBody, NotificationFrequency: model.GetUpdateKeywordsAlarmRuleRequestBodyNotificationFrequencyEnum().E_5, NotificationSaveRule: notificationSaveRulebody, DomainId: "", KeywordsAlarmSendCode: model.GetUpdateKeywordsAlarmRuleRequestBodyKeywordsAlarmSendCodeEnum().E_2, KeywordsAlarmSend: true, KeywordsAlarmLevel: model.GetUpdateKeywordsAlarmRuleRequestBodyKeywordsAlarmLevelEnum().CRITICAL, Frequency: frequencybody, KeywordsRequests: listKeywordsRequestsbody, KeywordsAlarmRuleDescription: &keywordsAlarmRuleDescriptionUpdateKeywordsAlarmRuleRequestBody, AlarmRuleAlias: &alarmRuleAliasUpdateKeywordsAlarmRuleRequestBody, KeywordsAlarmRuleName: "huawei", KeywordsAlarmRuleId: "", } response, err := client.UpdateKeywordsAlarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
400 |
BadRequest 非法请求 建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。