文档首页/ 云日志服务 LTS/ 更多文档/ API参考（吉隆坡区域）/ API/ 关键词告警规则/ 修改关键词告警规则

更新时间：2025-03-21 GMT+08:00

查看PDF

修改关键词告警规则

功能介绍

该接口用于修改关键词告警。

URI

PUT /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_id	是	String	关键词告警规则id 最小长度：36 最大长度：36
keywords_alarm_rule_name	是	String	规则原始名称（不支持修改首次创建的原始名称。）最小长度：1 最大长度：64
alarm_rule_alias	否	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	是否发送
keywords_alarm_send_code	是	Integer	发送主题 0:不变 1:新增 2:修改 3:删除最小值：0 最大值：3
domain_id	是	String	账号ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：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
log_stream_name	否	String	日志流名称
log_group_id	是	String	日志组id
log_group_name	否	String	日志组名称
keywords	是	String	关键词。
condition	是	String	条件。
number	是	Integer	关键词阈值，与keyword和condition组成条件，满足条件触发告警。
search_time_range	是	Integer	查询执行任务时最近数据的时间范围
search_time_range_unit	是	String	查询时间单位

表5 Frequency
参数	是否必选	参数类型	描述
type	是	String	时间类型。
cron_expr	否	String	CRON表达式：CRON表达式的最小精度为分钟，格式为24小时制。 • 0/10 * * * 从00:00开始，每隔整10分钟查询一次，分别为10分钟、20分钟、30分钟、40分钟、50分钟、60分钟。例如：当前时间为16:37，下一次查询时间为16:50。 • 0 0/5 * 从00:00开始，每隔5小时查询一次，分别为0时、5时、10时、15时、20时。例如：当前时间为16:37，下一次查询时间为20:00。 • 0 14 * 每天14:00查询一次。 • 0 0 10 *每月10日00:00查询一次
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组合使用，表达一个固定的时间周期。
fixed_rate_unit	否	String	时间周期的单位，当字段type为"FIXED_RATE"时取该字段，与fixed_rate组合使用，表达一个固定的时间周期。取值为hour、minute

表6 SqlNotificationSaveRule
参数	是否必选	参数类型	描述
language	是	String	首选项对应的语言最小长度：0 最大长度：10
timezone	否	String	通知消息中使用的时区信息。例：+08:00 最小长度：0 最大长度：1024
user_name	是	String	通知消息中使用的用户名称，一般出现在第一行的问候语中。最小长度：1 最大长度：1024
topics	是	Array of Topics objects	主题信息，即将下线，推荐使用行动规则
template_name	是	String	消息模板名称

表7 Topics
参数	是否必选	参数类型	描述
name	是	String	主题名称。
topic_urn	是	String	Topic的唯一的资源标识。
display_name	否	String	Topic的显示名，推送邮件消息时，作为邮件发件人显示。
push_policy	否	Integer	消息推送的策略。

响应参数

状态码：200

表8 响应Body参数
参数	参数类型	描述
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

表9 KeywordsResBody
参数	参数类型	描述
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	查询时间单位

**表10** FrequencyRespBody
参数	参数类型	描述
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	时间单位枚举值：

**表11** Topics
参数	参数类型	描述
name	String	主题名称。
topic_urn	String	Topic的唯一的资源标识。
display_name	String	Topic的显示名，推送邮件消息时，作为邮件发件人显示。
push_policy	Integer	消息推送的策略。

状态码：400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	调用失败响应信息描述。

状态码：500

**表13** 响应Body参数
参数	参数类型	描述
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" : "test",
  "alarm_rule_alias" : "zhangsan",
  "keywords_alarm_rule_description" : "test",
  "keywords_requests" : [ {
    "log_stream_id" : "1",
    "log_group_id" : "1",
    "keywords" : "test",
    "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" : "en-us",
    "timezone" : "xx/xx",
    "user_name" : "test",
    "template_name" : "消息模板名称",
    "topics" : [ {
      "name" : "test",
      "topic_urn" : "urn:smn:xxxx-7:1b06fc5dc0814a4da1594a9ade9cb93c:test",
      "display_name" : "",
      "push_policy" : 0
    } ]
  }
}

响应示例

状态码：200

请求响应成功。

{
  "keywords_alarm_rule_id" : "",
  "keywords_alarm_rule_name" : "test",
  "keywords_alarm_rule_description" : "test",
  "alarm_rule_alias" : "zhangsan",
  "keywords_requests" : [ {
    "log_stream_id" : "1",
    "log_stream_name" : "test",
    "log_group_name" : "test",
    "log_group_id" : "1",
    "keywords" : "test",
    "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" : "test",
    "topic_urn" : "urn:smn:xxxx-7:1b06fc5dc0814a4da1594a9ade9cb93c:test",
    "display_name" : "",
    "push_policy" : 0
  } ],
  "language" : "en-us"
}

状态码：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."
}

状态码

状态码	描述
200	请求响应成功。
400	BadRequest 非法请求建议根据error_msg直接修改该请求。
500	表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： 关键词告警规则

上一篇：创建关键词告警规则

下一篇：查询关键词告警规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消