# 修改关键词告警规则 - UpdateKeywordsAlarmRule #### 功能介绍 该接口用于修改关键词告警。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:alarmRule:updateWordAlarmRule | Write | alarmRule \* | g:ResourceTag/\ | lts:sqlalarmrules:put | - | | lts:alarmRule:updateWordAlarmRule | Write | - | - g:RequestTag/\ - g:TagKeys | lts:sqlalarmrules:put | - | #### URI PUT /v2/{project_id}/lts/alarms/keywords-alarm-rule 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见：[获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | keywords_alarm_rule_id | 是 | String | **参数解释：** 关键词告警规则ID。 **约束限制：** - 支持修改规则名称，不支持修改首次创建的原始名称。 - 支持输入英文、数字、中文、中划线、下划线，且不能以中划线、下划线开头或结尾。 - 最大长度不超过128个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | keywords_alarm_rule_name | 是 | String | **参数解释：** 关键词告警规则名称。 **约束限制：** 支持修改规则名称，不支持修改首次创建的原始名称。 **取值范围：** 支持输入英文、数字、中文、中划线、下划线，且不能以中划线、下划线开头或结尾。 最大长度不超过128个字符。 **默认取值：** 不涉及。 | | alarm_rule_alias | 否 | 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](https://support.huaweicloud.com/api-lts/lts_api_0012.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | 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 **默认取值：** 3 | | notification_frequency | 是 | Integer | **参数解释：** 告警通知频率。有立即通知、每5分钟、每10分钟、每15分钟、每30分钟、每1小时、每3小时、每6小时。 其中，立即通知指只要产生告警就发送通知，每10分钟指的是两次通知之间最小时间间隔为10分钟，可避免告警轰炸。 **约束限制：** 不涉及。 **取值范围：** - 0 - 5 - 10 - 15 - 30 - 60 - 180 - 360 **默认取值：** 不涉及。 | | alarm_action_rule_name | 否 | String | **参数解释：** 告警行动规则名称。 **约束限制：** 不涉及。 **取值范围：** - 支持输入英文、数字、中文、中划线、下划线，且不能以中划线、下划线开头或结尾。 - 最大长度不超过128个字符。 **默认取值：** 不涉及。 | | tags | 否 | Array of [tagsRequestBody] objects | **参数解释：** 告警标签信息。标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 **约束限制：** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释：** 企业项目ID信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4KeywordsRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | log_stream_id | 是 | String | **参数解释：** 日志流ID，获取方式请参见：[获取日志组ID和日志流ID](https://support.huaweicloud.com/api-lts/lts_api_0014.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_stream_name | 否 | String | **参数解释：** 日志流名称。 当日志组下有多个日志流时，支持选择多个日志流，即可批量创建关键词告警。 **约束限制：** - 只支持输入英文、数字、中文、中划线、下划线及小数点，且不能以小数点、下划线开头或以小数点结尾。 - 长度为1-64个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_group_id | 是 | String | **参数解释：** 日志组ID，获取方式请参见：[获取日志组ID和日志流ID](https://support.huaweicloud.com/api-lts/lts_api_0014.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_group_name | 否 | String | **参数解释：** 日志组名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | keywords | 是 | String | **参数解释：** 在日志搜索能查到的日志关键字。关键词支持精确匹配和模糊匹配，输入长度不超过1024个字符。如何设置关键词搜索请参考[搜索语法介绍](https://support.huaweicloud.com/usermanual-lts/lts_05_0111.html)。 **约束限制：** 不涉及。 **取值范围：** 长度不能超过1024个字符。 **默认取值：** 不涉及。 | | condition | 是 | String | **参数解释：** 触发条件，即满足该条件时，会触发告警。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | number | 是 | Integer | **参数解释：** 匹配条数。当关键词搜索结果的日志条数达到设定的条数时，会触发告警。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | search_time_range | 是 | Integer | **参数解释：** 查询执行告警任务时最近数据的时间范围。 **约束限制：** - 当search_time_range_unit为minute，则最大值为60。 - 当search_time_range_unit为hour，则最大值为24。 - 当custom_date字段不为null时，该字段不生效。 **取值范围：** 1-60 **默认取值：** 1 | | search_time_range_unit | 是 | String | **参数解释：** 查询告警时间范围单位。（暂不开放，后续aom上线该功能后一起开放） **约束限制：** - today仅支持is_time_range_relative为true时配置。 - 当custom_date字段不为null时，该字段不生效。 - minute - hour - today - yesterday **取值范围：** **默认取值：** minute | | custom_date | 否 | [CustomDate] object | **参数解释：** 根据与告警执行时间的相对时间自定义告警查询时间区间。（暂不开放，后续aom上线该功能后一起开放） **约束限制：** 不涉及。 | | is_time_range_relative | 否 | Boolean | **参数解释：** 是否是相对时间。（暂不开放，后续aom上线该功能后一起开放） **约束限制：** 不涉及。 **取值范围：** - true：相对时间。 - false：整点时间。 **默认取值：** true | | conditions | 否 | Array of [KeywordsAlarmConditions] objects | **参数解释：** 支持根据不同条件触发不同级别的告警。当使用该参数时，将优先使用该参数中的条件触发告警，无视keywords_alarm_level参数以及keywords_requests中的condition、number参数。 **约束限制：** 不涉及。 | 表5CustomDate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start | 是 | Integer | **参数解释：** 查询起始时间相对于告警计划执行时间的偏移量数值。 **约束限制：** 根据start_unit字段的单位将有不同的取值范围，根据单位将start换算为时间不超过1天。 **取值范围：** - start_unit取值为second，start取值范围为 1-86400； - start_unit取值为minute，start取值范围为 1-1440； - start_unit取值为hour，start取值范围为 1-24。 **默认取值：** 不涉及。 | | start_unit | 是 | String | **参数解释：** 查询起始时间相对于告警计划执行时间的偏移量单位。 **约束限制：** 整点时间即is_time_range_relative为false时start_unit不支持second。 **取值范围：** - hour - minute - second **默认取值：** minute | | end | 是 | Integer | **参数解释：** 查询结束时间相对于告警计划执行时间的偏移量数值。 **约束限制：** 根据end_unit字段的单位将有不同的取值范围，根据单位将end换算为时间不超过1天； **取值范围：** - end_unit取值为second，end取值范围为 0-86399； - end_unit取值为minute，end取值范围为 0-1439； - end_unit取值为hour，end取值范围为 0-23。 **默认取值：** 不涉及。 | | end_unit | 是 | String | **参数解释：** 查询结束时间相对于告警计划执行时间的偏移量单位。 **约束限制：** 整点时间即is_time_range_relative为false时end_unit不支持second。 **取值范围：** - hour - minute - second **默认取值：** minute | 表6KeywordsAlarmConditions | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | condition | 是 | String | **参数解释：** 触发条件，即满足该条件时，会触发告警。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | number | 是 | Integer | **参数解释：** 匹配条数。当关键词搜索结果的日志条数达到设定的条数时，会触发告警。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | alarm_level | 是 | String | **参数解释：** 告警级别。 **约束限制：** 不涉及。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 **默认取值：** 不涉及。 | 表7Frequency | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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时，填写该字段。 **约束限制：** 不涉及。 **取值范围：** 0-23 **默认取值：** 不涉及。 | | day_of_week | 否 | Integer | **参数解释：** 每周。当type取值为WEEKLY时，填写该字段。 **约束限制：** 不涉及。 **取值范围：** 1-7。1表示周日，7表示周六。 **默认取值：** 不涉及。 | | fixed_rate | 否 | Integer | **参数解释：** 固定间隔。当type取值为FIXED_RATE时，填写该字段。 **约束限制：** 不涉及。 **取值范围：** - 当fixed_rate_unit（固定间隔时间单位）为minute，取值范围1-60。 - 当fixed_rate_unit（固定间隔时间单位）为hour，取值范围1-24。 **默认取值：** 不涉及。 | | fixed_rate_unit | 否 | String | **参数解释：** 固定间隔时间单位。 **约束限制：** 不涉及。 **取值范围：** - minute - hour **默认取值：** 不涉及。 | 表8tagsRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签键。 **约束限制：** - 标签键名称不可重复。 - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 - 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 首尾不能包含空格，且不能以_sys_开头。 - 长度不能超过128个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | value | 否 | String | **参数解释：** 标签值。 **约束限制：** - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 - 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 标签值长度不能超过255个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表9响应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 [KeywordsRequestResponse] objects | **参数解释：** 关键词告警规则信息。 | | frequency | [FrequencyRespBody] object | **参数解释：** 关键词告警统计周期信息。 | | keywords_alarm_level | String | **参数解释：** 关键词告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | | keywords_alarm_send | Boolean | **参数解释：** 是否发送告警通知。 **取值范围：** - true：发送告警通知。 - false：不发送告警通知。 | | domain_id | String | **参数解释：** 账号ID，获取方式请参见：[获取账号ID](https://support.huaweicloud.com/api-lts/lts_api_0012.html)。 **取值范围：** 不涉及。 | | create_time | Long | **参数解释：** 创建关键词告警的时间(毫秒时间戳)。 **取值范围：** 不涉及。 | | update_time | Long | **参数解释：** 更新关键词告警的时间(毫秒时间戳)。 **取值范围：** 不涉及。 | | projectId | String | **参数解释：** 项目ID。 **取值范围：** 不涉及。 | | condition_expression | String | **参数解释：** 告警条件表达式。 **取值范围：** 不涉及。 | | trigger_condition_count | Integer | **参数解释：** 告警触发条件：满足条件次数。满足条件次数是指设置的关键词。 在统计周期次数内且满足条件次数时，可触发关键词告警。 **取值范围：** 不涉及。 | | trigger_condition_frequency | Integer | **参数解释：** 告警触发条件：统计周期次数。统计周期次数指高级设置的统计周期。 当在统计周期次数内且满足条件次数时，可触发关键词告警。 **取值范围：** 1-10 | | whether_recovery_policy | Boolean | **参数解释：** 是否配置告警恢复策略。满足该策略时，会发送告警恢复通知。 **取值范围：** true：配置告警恢复策略。 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 - 360 | | alarm_action_rule_name | String | **参数解释：** 告警行动规则名称。 **取值范围：** 不涉及。 | | tags | Array of [tagsResBody] objects | **参数解释：** 告警标签信息。标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 | 表10KeywordsRequestResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | log_stream_id | String | **参数解释：** 日志流ID，获取方式请参见：[获取日志组ID和日志流ID](https://support.huaweicloud.com/api-lts/lts_api_0014.html)。 **取值范围：** 不涉及。 | | log_stream_name | String | **参数解释：** 日志流名称。 **取值范围：** 不涉及。 | | log_group_id | String | **参数解释：** 日志组ID。 **取值范围：** 不涉及。 | | log_group_name | String | **参数解释：** 日志组名称。 **取值范围：** 不涉及。 | | keywords | String | **参数解释：** 在日志搜索能查到的日志关键字。 **取值范围：** 不涉及。 | | condition | String | **参数解释：** 告警查询条件。 **取值范围：** \<、\>、 \<=、\>= | | number | Integer | **参数解释：** 告警匹配条数。 **取值范围：** 不涉及。 | | search_time_range | Integer | **参数解释：** 查询执行告警任务时最近数据的时间范围。 **取值范围：** - 最小值：1 - 最大值：60 | | search_time_range_unit | String | **参数解释：** 查询告警时间范围单位。 **取值范围：** - minute - hour | | custom_date | [CustomDate] object | **参数解释：** 根据与告警执行时间的相对时间自定义告警查询时间区间。 | | is_time_range_relative | Boolean | **参数解释：** 告警查询日志的时间区间为相对时间还是整点时间。 **取值范围：** - true: 相对时间。 - false: 整点时间。 | | conditions | Array of [KeywordsAlarmConditions] objects | **参数解释：** 支持根据不同条件触发不同级别的告警。当使用该参数时，将优先使用该参数中的条件触发告警，无视keywords_alarm_level参数以及keywords_requests中的condition、number参数。 | | log_group_name_alias | String | **参数解释：** 日志组别名。 **取值范围：** 不涉及。 | | log_stream_name_alias | String | **参数解释：** 日志流别名。 **取值范围：** 不涉及。 | | eps_id | String | **参数解释：** 企业项目ID。 **取值范围：** 不涉及。 | | time_range | [TimeRange] object | **参数解释：** 时间范围配置。 | 表11CustomDate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | start | Integer | **参数解释：** 查询起始时间相对于告警计划执行时间的偏移量数值。 **取值范围：** - start_unit取值为second，start取值范围为 1-86400； - start_unit取值为minute，start取值范围为 1-1440； - start_unit取值为hour，start取值范围为 1-24。 | | start_unit | String | **参数解释：** 查询起始时间相对于告警计划执行时间的偏移量单位。 **取值范围：** - hour - minute - second | | end | Integer | **参数解释：** 查询结束时间相对于告警计划执行时间的偏移量数值。 **取值范围：** - end_unit取值为second，end取值范围为 0-86399； - end_unit取值为minute，end取值范围为 0-1439； - end_unit取值为hour，end取值范围为 0-23。 | | end_unit | String | **参数解释：** 查询结束时间相对于告警计划执行时间的偏移量单位。 **取值范围：** - hour - minute - second | 表12KeywordsAlarmConditions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | condition | String | **参数解释：** 触发条件，即满足该条件时，会触发告警。 **取值范围：** 不涉及。 | | number | Integer | **参数解释：** 匹配条数。当关键词搜索结果的日志条数达到设定的条数时，会触发告警。 **取值范围：** 不涉及。 | | alarm_level | String | **参数解释：** 告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | 表13TimeRange | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sql_time_zone | String | **参数解释：** SQL语句的时区设置。用处理时间相关函数或时间类型的字段返回时的时区转换。 时区格式有-0800、 -08:00、America/Los_Angeles和UTC等。 例如：select MILLIS_TO_TIMESTAMP(0) as time 表示将毫秒值的时间戳转化为时间类型。 - 当sql_time_zone取值为UTC 时，time返回的时间格式为1970-01-01T00:00:00.000Z。 - 当sql_time_zone取值为+0800时，time返回的时间格式1970-01-01T08:00:00.000+08:00。 - 当sql_time_zone取值为America/Los_Angeles时，time返回的时间格式为1969-12-31T16:00:00.000-08:00。 **取值范围：** 不涉及。 | | start_time | Long | **参数解释：** 查询起始时间，timestamp时间戳格式，表示从1970-01-01T00:00:00.000Z UTC计算起的毫秒数。 **取值范围：** - 大于0。 - 当小于日志流保存时间的最小值时，会默认修改为日志流保存时间区间的最小值。 | | end_time | Long | **参数解释：** 查询结束时间，timestamp时间戳格式，表示从1970-01-01T00:00:00.000Z UTC计算起的毫秒数。 **取值范围：** 大于0。 | | start_time_gt | Boolean | **参数解释：** 查询是否包含起始时间点。 **取值范围：** - true：包含起始时间点。 - false：不包含起始时间点。 | | end_time_lt | Boolean | **参数解释：** 查询是否包含结束时间点。 **取值范围：** - true：包含结束时间点。 - false：不包含结束时间点。 | 表14FrequencyRespBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 告警统计周期类型。 **取值范围：** - CRON：cron表达式。 - HOURLY：每小时。 - DAILY：每天。 - WEEKLY：每周。 - FIXED_RATE：固定间隔。 | | cron_expr | String | **参数解释：** CRON表达式。当type取值为CRON时，返回该字段。CRON最小精度为分钟，格式为24小时制。 **取值范围：** 不涉及。 | | hour_of_day | Integer | **参数解释：** 每天每小时。当type取值为DAILY或HOURLY时，返回该字段。 **取值范围：** 不涉及。 | | day_of_week | Integer | **参数解释：** 每周。当type取值为WEEKLY时，返回该字段。 **取值范围：** 不涉及。 | | fixed_rate | Integer | **参数解释：** 固定间隔。当type取值为FIXED_RATE时，返回该字段。 **取值范围：** 不涉及。 | | fixed_rate_unit | String | **参数解释：** 固定间隔时间单位。 **取值范围：** - minute - hour | 表15tagsResBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 标签值。 **取值范围：** 不涉及。 | **状态码：400** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 修改关键词告警规则。 ``` PUT https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule { "keywords_requests" : [ { "log_group_id" : "38a0********************************d718", "log_group_name" : "lts-**********group", "log_stream_id" : "96ec********************************75f", "log_stream_name" : "lts-***********jiqi", "eps_id" : "0", "keywords" : "ERROR", "search_time_range" : 5, "search_time_range_unit" : "minute", "is_time_range_relative" : true, "domain_id" : "eb71********************************03f", "conditions" : [ { "condition" : ">", "number" : 5, "alarm_level" : "Critical" }, { "condition" : ">", "number" : 4, "alarm_level" : "Major" }, { "condition" : ">", "number" : 3, "alarm_level" : "Minor" }, { "condition" : ">", "number" : 2, "alarm_level" : "Info" } ], "number" : 5, "condition" : ">" } ], "domain_id" : "eb71********************************03f", "keywords_alarm_rule_name" : "tuod**********word", "alarm_rule_alias" : "tuod**********word", "keywords_alarm_rule_description" : "", "keywords_alarm_send" : true, "language" : "zh-cn", "status" : "RUNNING", "frequency" : { "type" : "FIXED_RATE", "cron_expr" : "", "hour_of_day" : 0, "day_of_week" : 1, "fixed_rate" : 1, "fixed_rate_unit" : "minute" }, "notification_frequency" : 0, "alarm_action_rule_name" : "***", "alarm_action_rule_flag" : true, "console_url" : "https://co****************************************-3", "enterprise_project_id" : "0", "trigger_condition_frequency" : 1, "trigger_condition_count" : 1, "recovery_policy" : 3, "whether_recovery_policy" : true, "keyword_alarm_level" : "Critical", "tags" : [ ], "keywords_alarm_rule_id" : "3bba********************************772", "keywords_alarm_send_code" : 0 } ``` #### 响应示例 **状态码：200** 请求响应成功。 ``` { "alarm_action_rule_name" : "330", "alarm_rule_alias" : "tuod**********word", "create_time" : 1779799438888, "domain_id" : "eb71********************************03f", "frequency" : { "cron_expr" : "", "day_of_week" : 1, "fixed_rate" : 1, "fixed_rate_unit" : "minute", "hour_of_day" : 0, "type" : "FIXED_RATE" }, "keywords_alarm_level" : "CRITICAL", "keywords_alarm_rule_description" : "", "keywords_alarm_rule_id" : "3bba********************************772", "keywords_alarm_rule_name" : "tuod**********word", "keywords_alarm_send" : true, "keywords_requests" : [ { "condition" : ">", "conditions" : [ { "alarm_level" : "CRITICAL", "condition" : ">", "number" : 5 }, { "alarm_level" : "MAJOR", "condition" : ">", "number" : 4 }, { "alarm_level" : "MINOR", "condition" : ">", "number" : 3 }, { "alarm_level" : "INFO", "condition" : ">", "number" : 2 } ], "eps_id" : "0", "is_time_range_relative" : true, "keywords" : "ERROR", "log_group_id" : "38a0********************************d718", "log_group_name" : "lts-**********group", "log_group_name_alias" : "lts-**********group", "log_stream_id" : "96ec********************************75f", "log_stream_name" : "lts-***********jiqi", "log_stream_name_alias" : "lts-***********jiqi", "number" : 5, "search_time_range" : 5, "search_time_range_unit" : "minute" } ], "notification_frequency" : 0, "projectId" : "05b5********************************4747", "recovery_policy" : 3, "tags" : [ ], "trigger_condition_count" : 1, "trigger_condition_frequency" : 1, "update_time" : 1779799719791, "whether_recovery_policy" : true } ``` **状态码：400** 非法请求，建议根据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代码示例如下。 - [Java] 修改关键词告警规则。 ``` 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("")) .build(); UpdateKeywordsAlarmRuleRequest request = new UpdateKeywordsAlarmRuleRequest(); UpdateKeywordsAlarmRuleRequestBody body = new UpdateKeywordsAlarmRuleRequestBody(); Frequency frequencybody = new Frequency(); frequencybody.withType(Frequency.TypeEnum.fromValue("FIXED_RATE")) .withCronExpr("") .withHourOfDay(0) .withDayOfWeek(1) .withFixedRate(1) .withFixedRateUnit(Frequency.FixedRateUnitEnum.fromValue("minute")); List listbodyKeywordsRequests = new ArrayList<>(); listbodyKeywordsRequests.add( new KeywordsRequest() .withLogStreamId("96ec********************************75f") .withLogStreamName("lts-***********jiqi") .withLogGroupId("38a0********************************d718") .withLogGroupName("lts-**********group") .withKeywords("ERROR") .withCondition(KeywordsRequest.ConditionEnum.fromValue(">")) .withNumber(5) .withSearchTimeRange(5) .withSearchTimeRangeUnit(KeywordsRequest.SearchTimeRangeUnitEnum.fromValue("minute")) .withIsTimeRangeRelative(true) ); body.withEnterpriseProjectId("0"); body.withAlarmActionRuleName("***"); body.withNotificationFrequency(UpdateKeywordsAlarmRuleRequestBody.NotificationFrequencyEnum.NUMBER_0); body.withRecoveryPolicy(3); body.withWhetherRecoveryPolicy(true); body.withTriggerConditionFrequency(1); body.withTriggerConditionCount(1); body.withDomainId("eb71********************************03f"); body.withFrequency(frequencybody); body.withKeywordsRequests(listbodyKeywordsRequests); body.withKeywordsAlarmRuleDescription(""); body.withAlarmRuleAlias("tuod**********word"); body.withKeywordsAlarmRuleName("tuod**********word"); body.withKeywordsAlarmRuleId("3bba********************************772"); 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()); } } } ``` - [Python] 修改关键词告警规则。 ``` # 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("")) \ .build() try: request = UpdateKeywordsAlarmRuleRequest() frequencybody = Frequency( type="FIXED_RATE", cron_expr="", hour_of_day=0, day_of_week=1, fixed_rate=1, fixed_rate_unit="minute" ) listKeywordsRequestsbody = [ KeywordsRequest( log_stream_id="96ec********************************75f", log_stream_name="lts-***********jiqi", log_group_id="38a0********************************d718", log_group_name="lts-**********group", keywords="ERROR", condition=">", number=5, search_time_range=5, search_time_range_unit="minute", is_time_range_relative=True ) ] request.body = UpdateKeywordsAlarmRuleRequestBody( enterprise_project_id="0", alarm_action_rule_name="***", notification_frequency=0, recovery_policy=3, whether_recovery_policy=True, trigger_condition_frequency=1, trigger_condition_count=1, domain_id="eb71********************************03f", frequency=frequencybody, keywords_requests=listKeywordsRequestsbody, keywords_alarm_rule_description="", alarm_rule_alias="tuod**********word", keywords_alarm_rule_name="tuod**********word", keywords_alarm_rule_id="3bba********************************772" ) 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) ``` - [Go] 修改关键词告警规则。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) request := &model.UpdateKeywordsAlarmRuleRequest{} cronExprFrequency:= "" hourOfDayFrequency:= int32(0) dayOfWeekFrequency:= int32(1) fixedRateFrequency:= int32(1) fixedRateUnitFrequency:= model.GetFrequencyFixedRateUnitEnum().MINUTE frequencybody := &model.Frequency{ Type: model.GetFrequencyTypeEnum().FIXED_RATE, CronExpr: &cronExprFrequency, HourOfDay: &hourOfDayFrequency, DayOfWeek: &dayOfWeekFrequency, FixedRate: &fixedRateFrequency, FixedRateUnit: &fixedRateUnitFrequency, } logStreamNameKeywordsRequests:= "lts-***********jiqi" logGroupNameKeywordsRequests:= "lts-**********group" isTimeRangeRelativeKeywordsRequests:= true var listKeywordsRequestsbody = []model.KeywordsRequest{ { LogStreamId: "96ec********************************75f", LogStreamName: &logStreamNameKeywordsRequests, LogGroupId: "38a0********************************d718", LogGroupName: &logGroupNameKeywordsRequests, Keywords: "ERROR", Condition: model.GetKeywordsRequestConditionEnum().GREATER_THAN, Number: int32(5), SearchTimeRange: int32(5), SearchTimeRangeUnit: model.GetKeywordsRequestSearchTimeRangeUnitEnum().MINUTE, IsTimeRangeRelative: &isTimeRangeRelativeKeywordsRequests, }, } enterpriseProjectIdUpdateKeywordsAlarmRuleRequestBody:= "0" alarmActionRuleNameUpdateKeywordsAlarmRuleRequestBody:= "***" recoveryPolicyUpdateKeywordsAlarmRuleRequestBody:= int32(3) whetherRecoveryPolicyUpdateKeywordsAlarmRuleRequestBody:= true triggerConditionFrequencyUpdateKeywordsAlarmRuleRequestBody:= int32(1) triggerConditionCountUpdateKeywordsAlarmRuleRequestBody:= int32(1) keywordsAlarmRuleDescriptionUpdateKeywordsAlarmRuleRequestBody:= "" alarmRuleAliasUpdateKeywordsAlarmRuleRequestBody:= "tuod**********word" request.Body = &model.UpdateKeywordsAlarmRuleRequestBody{ EnterpriseProjectId: &enterpriseProjectIdUpdateKeywordsAlarmRuleRequestBody, AlarmActionRuleName: &alarmActionRuleNameUpdateKeywordsAlarmRuleRequestBody, NotificationFrequency: model.GetUpdateKeywordsAlarmRuleRequestBodyNotificationFrequencyEnum().E_0, RecoveryPolicy: &recoveryPolicyUpdateKeywordsAlarmRuleRequestBody, WhetherRecoveryPolicy: &whetherRecoveryPolicyUpdateKeywordsAlarmRuleRequestBody, TriggerConditionFrequency: &triggerConditionFrequencyUpdateKeywordsAlarmRuleRequestBody, TriggerConditionCount: &triggerConditionCountUpdateKeywordsAlarmRuleRequestBody, DomainId: "eb71********************************03f", Frequency: frequencybody, KeywordsRequests: listKeywordsRequestsbody, KeywordsAlarmRuleDescription: &keywordsAlarmRuleDescriptionUpdateKeywordsAlarmRuleRequestBody, AlarmRuleAlias: &alarmRuleAliasUpdateKeywordsAlarmRuleRequestBody, KeywordsAlarmRuleName: "tuod**********word", KeywordsAlarmRuleId: "3bba********************************772", } response, err := client.UpdateKeywordsAlarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=UpdateKeywordsAlarmRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求响应成功。 | | 400 | 非法请求，建议根据error_msg直接修改该请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。