# 修改SQL告警规则 - UpdateSqlAlarmRule #### 功能介绍 修改SQL告警规则。 #### 调用方法 请参见[如何调用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:updateSqlAlarmRule | Write | alarmRule \* | g:ResourceTag/\ | lts:sqlalarmrules:put | - | | lts:alarmRule:updateSqlAlarmRule | Write | - | - g:RequestTag/\ - g:TagKeys | lts:sqlalarmrules:put | - | #### URI PUT /v2/{project_id}/lts/alarms/sql-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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | sql_alarm_rule_id | 是 | String | **参数解释：** SQL告警规则ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sql_alarm_rule_name | 是 | String | **参数解释：** SQL告警规则名称。 **约束限制：** - 只支持输入英文、数字、中文、中划线、下划线，且不能以中划线、下划线开头或结尾。 - 最大长度不超过128个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | alarm_rule_alias | 否 | String | **参数解释：** SQL告警规则别名。 **约束限制：** - 只支持输入英文、数字、中文、中划线、下划线，且不能以中划线、下划线开头或结尾。 - 最大长度不超过128个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | is_css_sql | 否 | Boolean | **参数解释：** 是否使用管道符SQL查询。 **约束限制：** 不涉及。 **取值范围：** - true：搜索分析告警。 - false：SQL告警。 **默认取值：** false | | sql_alarm_rule_description | 否 | String | **参数解释：** SQL告警规则的简要描述。 **约束限制：** 不涉及。 **取值范围：** 长度不能超过128个字符。 **默认取值：** 不涉及。 | | sql_requests | 是 | Array of [SqlRequest] objects | **参数解释：** SQL查询所需的相关参数。包括SQL语句，查询时间区间，是否包含边界时间等。 **约束限制：** 不涉及。 | | frequency | 是 | [CreateSqlAlarmRuleFrequency] object | **参数解释：** SQL告警执行周期信息。 **约束限制：** 不涉及。 | | condition_expression | 否 | String | **参数解释：** 触发告警的条件表达式。 **约束限制：** - 不支持纯数字。 - 不支持以数字开头的。 -当condition_expressions参数存在时，该参数可不填。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sql_alarm_level | 否 | String | **参数解释：** SQL告警级别。 **约束限制：** 不支持纯数字，不支持以数字开头的。 当condition_expressions参数存在时，该参数可不填。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 **默认取值：** 不涉及。 | | domain_id | 是 | String | **参数解释：** 账号ID，获取方式请参见：[获取账号ID](https://support.huaweicloud.com/api-lts/lts_api_0012.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | trigger_condition_count | 否 | Integer | **参数解释：** 告警触发条件：满足条件次数。满足条件次数是指设置的SQL语句。 在统计周期次数内且满足条件次数时，可触发SQL告警。 **约束限制：** - trigger_condition_count和trigger_condition_frequency需同时配置才能触发SQL告警。 - 配置的统计周期次数须大于等于满足触发条件次数。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | trigger_condition_frequency | 否 | Integer | **参数解释：** 告警触发条件：统计周期次数。统计周期次数指高级设置的统计周期。 当在统计周期次数内且满足条件次数时，可触发SQL告警。 **约束限制：** - trigger_condition_count和trigger_condition_frequency需同时配置才能触发SQL告警。 - 配置的统计周期次数须大于等于满足触发条件次数。 **取值范围：** 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信息。 **约束限制：** 不涉及。 | | condition_expressions | 否 | Array of [AlarmCondition] objects | **参数解释：** 支持根据不同条件触发不同级别的告警。当使用该参数时，将优先使用该参数中的条件触发告警，无视condition_expression、sql_alarm_level参数。 **约束限制：** 不涉及。 | 表4SqlRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | **参数解释：** 日志组名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sql | 是 | String | **参数解释：** SQL语句。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | 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 | 表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 | 表6CreateSqlAlarmRuleFrequency | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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、WEEKLY，填写该字段。 **约束限制：** 不涉及。 **取值范围：** 0-23 **默认取值：** 不涉及。 | | day_of_week | 否 | Integer | **参数解释：** 每周。当type取值为WEEKLY时，填写该字段。 **约束限制：** 不涉及。 **取值范围：** 0\~7。从1开始，以周日为第一天，依次对应周日到周六。取值为0时代表不以每周为统计周期。 **默认取值：** 不涉及。 | | fixed_rate | 否 | Integer | **参数解释：** 固定间隔。当type取值为FIXED_RATE时，填写该字段。 **约束限制：** 不涉及。 **取值范围：** - 当fixed_rate_unit（固定间隔时间单位）为minute，取值范围1-60。 - 当fixed_rate_unit（固定间隔时间单位）为hour，取值范围1-24。 **默认取值：** 不涉及。 | | fixed_rate_unit | 否 | String | **参数解释：** 固定间隔时间单位。 **约束限制：** 不涉及。 **取值范围：** - minute - hour **默认取值：** 不涉及。 | 表7tagsRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签键。 **约束限制：** - 标签键名称不可重复。 - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 - 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 首尾不能包含空格，且不能以_sys_开头。 - 长度不能超过128个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | value | 否 | String | **参数解释：** 标签值。 **约束限制：** - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 - 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 标签值长度不能超过255个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表8AlarmCondition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | condition_expression | 是 | String | **参数解释：** 触发告警的条件表达式。 **约束限制：** - 不支持纯数字。 - 不支持以数字开头的。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | alarm_level | 是 | String | **参数解释：** 触发的告警级别。 **约束限制：** 不支持纯数字，不支持以数字开头的。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sql_alarm_rule_name | String | **参数解释：** SQL告警规则原始名称。 **取值范围：** 不涉及。 | | alarm_rule_alias | String | **参数解释：** SQL告警规则别名。 **取值范围：** 不涉及。 | | is_css_sql | Boolean | **参数解释：** 是否管道符SQL查询。 **取值范围：** 不涉及。 | | projectId | String | **参数解释：** 项目ID。 **取值范围：** 不涉及。 | | sql_alarm_rule_id | String | **参数解释：** SQL告警规则ID。 **取值范围：** 不涉及。 | | sql_alarm_rule_description | String | **参数解释：** SQL告警信息描述。 **取值范围：** 不涉及。 | | sql_requests | Array of [SqlRequestResponse] objects | **参数解释：** SQL查询所需的相关参数。包括SQL语句，查询时间区间，是否包包含边界时间等。 | | frequency | [FrequencyRespBody] object | **参数解释：** 告警执行周期。 | | condition_expression | String | **参数解释：** 告警触发条件表达式。 **取值范围：** 不涉及。 | | sql_alarm_level | String | **参数解释：** 告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | | sql_alarm_send | Boolean | **参数解释：** 告警是否发送。 **取值范围：** - 0：不变 - 1：新增 - 2：修改 - 3：删除 | | domain_id | String | **参数解释：** 账号ID。 **取值范围：** 不涉及。 | | trigger_condition_count | Integer | **参数解释：** 告警触发条件：满足条件次数。满足条件次数是指设置的SQL语句。 **取值范围：** 不涉及。 | | trigger_condition_frequency | Integer | **参数解释：** 触发条件：触发周期。 **取值范围：** 不涉及。 | | whether_recovery_policy | Boolean | **参数解释：** 是否配置告警恢复策略。满足该策略时，会发送告警恢复通知。 **取值范围：** - true：配置告警恢复策略。 - false：不配置告警恢复策略。 | | recovery_policy | Integer | **参数解释：** 恢复策略周期。 **取值范围：** 不涉及。 | | notification_frequency | Integer | **参数解释：** 告警通知频率。有立即通知、每5分钟、每10分钟、每15分钟、每30分钟、每1小时、每3小时、每6小时。 其中，立即通知指只要产生告警就发送通知，每10分钟指的是两次通知之间最小时间间隔为10分钟，可避免告警轰炸。 **取值范围：** 不涉及。 | | alarm_action_rule_name | String | **参数解释：** 告警行动规则名称。 **取值范围：** 不涉及。 | | tags | Array of [tagsResBody] objects | **参数解释：** 告警标签信息。标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 | | create_time | Long | **参数解释：** 告警规则创建的时间，毫秒级的时间戳。 **取值范围** 不涉及。 | | update_time | Long | **参数解释：** 告警规则最后一次修改的时间，毫秒级的时间戳。 **取值范围：** 不涉及。 | | condition_expressions | Array of [AlarmCondition] objects | **参数解释：** 支持根据不同条件触发不同级别的告警。当使用该参数时，将优先使用该参数中的条件触发告警，无视condition_expression、sql_alarm_level参数。 | 表10SqlRequestResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | log_stream_id | String | **参数解释：** 日志流ID。 **取值范围：** 不涉及。 | | log_stream_name | String | **参数解释：** 日志流名称。 **取值范围：** 不涉及。 | | log_group_id | String | **参数解释：** 日志组ID。 **取值范围：** 不涉及。 | | log_group_name | String | **参数解释：** 日志组名称。 **取值范围：** 不涉及。 | | sql | String | **参数解释：** SQL语句。 **取值范围：** 不涉及。 | | sql_request_title | String | **参数解释：** 配置告警关联的图表名称。 **取值范围：** 不涉及。 | | search_time_range | Integer | **参数解释：** 查询执行告警任务时最近数据的时间范围。 **取值范围：** 不涉及。 | | search_time_range_unit | String | **参数解释：** 查询告警时间范围单位。 **取值范围：** - minute - hour | | custom_date | [CustomDate] object | **参数解释：** 根据与告警执行时间的相对时间自定义告警查询时间区间。 | | is_time_range_relative | Boolean | **参数解释：** 告警查询日志的时间区间为相对时间还是整点时间。 **取值范围：** - true: 相对时间。 - false: 整点时间。 | | log_group_name_alias | String | **参数解释：** 日志组别名。 | | log_stream_name_alias | String | **参数解释：** 日志流别名。 | 表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 | 表12FrequencyRespBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表13tagsResBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 标签值。 **取值范围：** 不涉及。 | 表14AlarmCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | condition_expression | String | **参数解释：** 触发告警的条件表达式。 **取值范围：** 不涉及。 | | alarm_level | String | **参数解释：** 触发的告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | **状态码：400** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 修改SQL告警规则。 ``` PUT https://{endpoint}/v2/{project_id}/lts/alarms/sql-alarm-rule { "alarm_action_rule_name" : "30", "alarm_rule_alias" : "tu**********测试", "condition_expression" : "pv > 4", "condition_expressions" : [ { "alarm_level" : "CRITICAL", "condition_expression" : "pv > 4" }, { "alarm_level" : "MAJOR", "condition_expression" : "pv > 3" }, { "alarm_level" : "MINOR", "condition_expression" : "pv > 2" }, { "alarm_level" : "INFO", "condition_expression" : "pv > 1" } ], "domain_id" : "eb***************************3f", "frequency" : { "cron_expr" : "", "day_of_week" : 1, "fixed_rate" : 1, "fixed_rate_unit" : "minute", "hour_of_day" : 0, "type" : "FIXED_RATE" }, "notification_frequency" : 0, "recovery_policy" : 1, "sql_alarm_level" : "CRITICAL", "sql_alarm_rule_description" : "", "sql_alarm_rule_id" : "cf**********************************3b", "sql_alarm_rule_name" : "tu**********恢复", "sql_requests" : [ { "is_time_range_relative" : true, "log_group_id" : "38***************************18", "log_group_name" : "lt**********group", "log_stream_id" : "96***************************5f", "log_stream_name" : "lt**********qi", "search_time_range" : 5, "search_time_range_unit" : "minute", "sql" : "* | SE*********** from' as x limit 1" } ], "tags" : [ ], "trigger_condition_count" : 1, "trigger_condition_frequency" : 1, "whether_recovery_policy" : true } ``` #### 响应示例 **状态码：200** 请求响应成功。 ``` { "alarm_action_rule_name" : "30", "alarm_rule_alias" : "tu**********测试", "condition_expression" : "pv > 4", "condition_expressions" : [ { "alarm_level" : "CRITICAL", "condition_expression" : "pv > 4" }, { "alarm_level" : "MAJOR", "condition_expression" : "pv > 3" }, { "alarm_level" : "MINOR", "condition_expression" : "pv > 2" }, { "alarm_level" : "INFO", "condition_expression" : "pv > 1" } ], "console_url" : "ht***********************2-3", "create_time" : 1773129332753, "domain_id" : "eb***************************3f", "enterprise_project_id" : "0", "frequency" : { "cron_expr" : "", "day_of_week" : 1, "fixed_rate" : 1, "fixed_rate_unit" : "minute", "hour_of_day" : 0, "type" : "FIXED_RATE" }, "id" : "cf**********************************3b", "indexId" : "", "is_css_sql" : true, "key" : "cf**********************************3b", "language" : "zh**", "notification_frequency" : 0, "projectId" : "05***************************47", "recovery_policy" : 1, "route_group_rule" : "", "sql_alarm_level" : "CRITICAL", "sql_alarm_rule_description" : "", "sql_alarm_rule_id" : "cf**********************************3b", "sql_alarm_rule_name" : "tu**********恢复", "sql_alarm_send" : true, "sql_requests" : [ { "eps_id" : "0", "is_druid_to_trino" : false, "is_time_range_relative" : true, "log_group_id" : "38***************************18", "log_group_name" : "lt**********group", "log_group_name_alias" : "lt**********group", "log_stream_id" : "96***************************5f", "log_stream_name" : "lt**********qi", "log_stream_name_alias" : "lt**********qi", "search_time_range" : 5, "search_time_range_unit" : "minute", "sql" : "* | SE*********** from' as x limit 1", "sql_request_title" : "" } ], "status" : "RUNNING", "tags" : [ ], "topics" : [ ], "trigger_condition_count" : 1, "trigger_condition_frequency" : 1, "update_time" : 1779798129316, "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] 修改SQL告警规则。 ``` 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 UpdateSqlAlarmRuleSolution { 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(); UpdateSqlAlarmRuleRequest request = new UpdateSqlAlarmRuleRequest(); UpdateSqlAlarmRuleRequestBody body = new UpdateSqlAlarmRuleRequestBody(); CreateSqlAlarmRuleFrequency frequencybody = new CreateSqlAlarmRuleFrequency(); frequencybody.withType(CreateSqlAlarmRuleFrequency.TypeEnum.fromValue("FIXED_RATE")) .withCronExpr("") .withHourOfDay(0) .withDayOfWeek(1) .withFixedRate(1) .withFixedRateUnit(CreateSqlAlarmRuleFrequency.FixedRateUnitEnum.fromValue("minute")); List listbodySqlRequests = new ArrayList<>(); listbodySqlRequests.add( new SqlRequest() .withLogStreamId("96***************************5f") .withLogStreamName("lt**********qi") .withLogGroupId("38***************************18") .withLogGroupName("lt**********group") .withSql("* | SE*********** from' as x limit 1") .withSearchTimeRange(5) .withSearchTimeRangeUnit(SqlRequest.SearchTimeRangeUnitEnum.fromValue("minute")) .withIsTimeRangeRelative(true) ); body.withAlarmActionRuleName("30"); body.withNotificationFrequency(UpdateSqlAlarmRuleRequestBody.NotificationFrequencyEnum.NUMBER_0); body.withRecoveryPolicy(1); body.withWhetherRecoveryPolicy(true); body.withTriggerConditionFrequency(1); body.withTriggerConditionCount(1); body.withDomainId("eb***************************3f"); body.withSqlAlarmLevel(UpdateSqlAlarmRuleRequestBody.UpdateSqlAlarmRuleRequestBody.fromValue("CRITICAL")); body.withConditionExpression("pv > 4"); body.withFrequency(frequencybody); body.withSqlRequests(listbodySqlRequests); body.withSqlAlarmRuleDescription(""); body.withAlarmRuleAlias("tu**********测试"); body.withSqlAlarmRuleName("tu**********恢复"); body.withSqlAlarmRuleId("cf**********************************3b"); request.withBody(body); try { UpdateSqlAlarmRuleResponse response = client.updateSqlAlarmRule(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] 修改SQL告警规则。 ``` # 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 = UpdateSqlAlarmRuleRequest() frequencybody = CreateSqlAlarmRuleFrequency( type="FIXED_RATE", cron_expr="", hour_of_day=0, day_of_week=1, fixed_rate=1, fixed_rate_unit="minute" ) listSqlRequestsbody = [ SqlRequest( log_stream_id="96***************************5f", log_stream_name="lt**********qi", log_group_id="38***************************18", log_group_name="lt**********group", sql="* | SE*********** from' as x limit 1", search_time_range=5, search_time_range_unit="minute", is_time_range_relative=True ) ] request.body = UpdateSqlAlarmRuleRequestBody( alarm_action_rule_name="30", notification_frequency=0, recovery_policy=1, whether_recovery_policy=True, trigger_condition_frequency=1, trigger_condition_count=1, domain_id="eb***************************3f", sql_alarm_level="CRITICAL", condition_expression="pv > 4", frequency=frequencybody, sql_requests=listSqlRequestsbody, sql_alarm_rule_description="", alarm_rule_alias="tu**********测试", sql_alarm_rule_name="tu**********恢复", sql_alarm_rule_id="cf**********************************3b" ) response = client.update_sql_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] 修改SQL告警规则。 ``` 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.UpdateSqlAlarmRuleRequest{} cronExprFrequency:= "" hourOfDayFrequency:= int32(0) dayOfWeekFrequency:= int32(1) fixedRateFrequency:= int32(1) fixedRateUnitFrequency:= model.GetCreateSqlAlarmRuleFrequencyFixedRateUnitEnum().MINUTE frequencybody := &model.CreateSqlAlarmRuleFrequency{ Type: model.GetCreateSqlAlarmRuleFrequencyTypeEnum().FIXED_RATE, CronExpr: &cronExprFrequency, HourOfDay: &hourOfDayFrequency, DayOfWeek: &dayOfWeekFrequency, FixedRate: &fixedRateFrequency, FixedRateUnit: &fixedRateUnitFrequency, } logStreamNameSqlRequests:= "lt**********qi" logGroupNameSqlRequests:= "lt**********group" searchTimeRangeSqlRequests:= int32(5) searchTimeRangeUnitSqlRequests:= model.GetSqlRequestSearchTimeRangeUnitEnum().MINUTE isTimeRangeRelativeSqlRequests:= true var listSqlRequestsbody = []model.SqlRequest{ { LogStreamId: "96***************************5f", LogStreamName: &logStreamNameSqlRequests, LogGroupId: "38***************************18", LogGroupName: &logGroupNameSqlRequests, Sql: "* | SE*********** from' as x limit 1", SearchTimeRange: &searchTimeRangeSqlRequests, SearchTimeRangeUnit: &searchTimeRangeUnitSqlRequests, IsTimeRangeRelative: &isTimeRangeRelativeSqlRequests, }, } alarmActionRuleNameUpdateSqlAlarmRuleRequestBody:= "30" recoveryPolicyUpdateSqlAlarmRuleRequestBody:= int32(1) whetherRecoveryPolicyUpdateSqlAlarmRuleRequestBody:= true triggerConditionFrequencyUpdateSqlAlarmRuleRequestBody:= int32(1) triggerConditionCountUpdateSqlAlarmRuleRequestBody:= int32(1) sqlAlarmRuleDescriptionUpdateSqlAlarmRuleRequestBody:= "" alarmRuleAliasUpdateSqlAlarmRuleRequestBody:= "tu**********测试" request.Body = &model.UpdateSqlAlarmRuleRequestBody{ AlarmActionRuleName: &alarmActionRuleNameUpdateSqlAlarmRuleRequestBody, NotificationFrequency: model.GetUpdateSqlAlarmRuleRequestBodyNotificationFrequencyEnum().E_0, RecoveryPolicy: &recoveryPolicyUpdateSqlAlarmRuleRequestBody, WhetherRecoveryPolicy: &whetherRecoveryPolicyUpdateSqlAlarmRuleRequestBody, TriggerConditionFrequency: &triggerConditionFrequencyUpdateSqlAlarmRuleRequestBody, TriggerConditionCount: &triggerConditionCountUpdateSqlAlarmRuleRequestBody, DomainId: "eb***************************3f", SqlAlarmLevel: model.GetUpdateSqlAlarmRuleRequestBodySqlAlarmLevelEnum().CRITICAL, ConditionExpression: "pv > 4", Frequency: frequencybody, SqlRequests: listSqlRequestsbody, SqlAlarmRuleDescription: &sqlAlarmRuleDescriptionUpdateSqlAlarmRuleRequestBody, AlarmRuleAlias: &alarmRuleAliasUpdateSqlAlarmRuleRequestBody, SqlAlarmRuleName: "tu**********恢复", SqlAlarmRuleId: "cf**********************************3b", } response, err := client.UpdateSqlAlarmRule(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=UpdateSqlAlarmRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求响应成功。 | | 400 | 非法请求，建议根据error_msg直接修改该请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。