# 查询SQL告警规则 - ListSqlAlarmRules #### 功能介绍 该接口用于查询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:listSqlAlarmRule | List | - | - | lts:sqlalarmrules:get | - | #### URI GET /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。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sql_alarm_rules | Array of [SqlAlarmRuleRespList] objects | **参数解释：** SQL告警规则信息。 | 表4SqlAlarmRuleRespList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sql_alarm_rule_name | String | **参数解释：** SQL告警规则名称。 **取值范围：** 不涉及。 | | is_css_sql | Boolean | **参数解释：** 是否管道符SQL查询。 **取值范围：** - true：搜索分析告警。 - false：SQL告警。 | | sql_alarm_rule_id | String | **参数解释：** SQL告警规则ID。 **取值范围：** 不涉及。 | | sql_alarm_rule_description | String | **参数解释：** SQL告警规则的简要描述。 **取值范围：** 不涉及。 | | sql_requests | Array of [SqlRequestResponse] objects | **参数解释：** SQL告警规则信息。 | | frequency | [FrequencyRespBody] object | **参数解释：** SQL告警统计周期信息。 | | condition_expression | String | **参数解释：** 触发告警的条件表达式。 **取值范围：** 不涉及。 | | topics | Array of [Topics] objects | **参数解释：** SMN主题信息。 | | sql_alarm_level | String | **参数解释：** 告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | | domain_id | String | **参数解释：** 账号ID。 **取值范围：** 不涉及。 | | create_time | Long | **参数解释：** 创建SQL告警的时间（毫秒时间戳）。 **取值范围：** 不涉及。 | | update_time | Long | **参数解释：** 修改SQL告警的时间（毫秒时间戳）。 **取值范围：** 不涉及。 | | template_name | String | **参数解释：** 消息模板名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 告警状态。 **取值范围：** - RUNNING - STOPPING | | trigger_condition_count | Integer | **参数解释：** 告警触发条件：满足条件次数。满足条件次数是指设置的SQL语句。 **取值范围：** 不涉及。 | | trigger_condition_frequency | Integer | **参数解释：** 告警触发条件：统计周期次数。统计周期次数指高级设置的统计周期。 **取值范围：** 不涉及。 | | whether_recovery_policy | Boolean | **参数解释：** 是否配置告警恢复策略。满足该策略时，会发送告警恢复通知。 **取值范围：** - true：配置告警恢复策略。 - false：不配置告警恢复策略。 | | recovery_policy | Integer | **参数解释：** 告警恢复策略周期次数。 **取值范围：** 不涉及。 | | notification_frequency | Integer | **参数解释：** 告警通知频率。 **取值范围：** - 0 - 5 - 10 - 15 - 30 - 60 - 180 - 360 | | alarm_action_rule_name | String | **参数解释：** 告警行动规则名称。 **取值范围：** 不涉及。 | | tags | Array of [tagsResBody] objects | **参数解释：** 告警标签信息。 | | condition_expressions | Array of [AlarmCondition] objects | **参数解释：** 支持根据不同条件触发不同级别的告警。当使用该参数时，将优先使用该参数中的条件触发告警，无视condition_expression、sql_alarm_level参数。 | 表5SqlRequestResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 日志流别名。 | 表6CustomDate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表7FrequencyRespBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表8Topics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** SMN主题名称。 **取值范围：** 不涉及。 | | topic_urn | String | **参数解释：** SMN主题的唯一的资源标识。 **取值范围：** 不涉及。 | | display_name | String | **参数解释：** 发送邮件时，显示的发件人名称。 **取值范围：** 不涉及。 | | push_policy | Integer | **参数解释：** 消息推送的策略，该属性目前不支持修改，后续将支持修改。 **取值范围：** - 0：发送失败，保留到失败队列。 - 1：直接丢弃发送失败的消息。 | 表9tagsResBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 标签值。 **取值范围：** 不涉及。 | 表10AlarmCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | condition_expression | String | **参数解释：** 触发告警的条件表达式。 **取值范围：** 不涉及。 | | alarm_level | String | **参数解释：** 触发的告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 查询SQL告警规则。 ``` GET https://{endpoint}/v2/{project_id}/lts/alarms/sql-alarm-rule /v2/{project_id}/lts/alarms/sql-alarm-rule ``` #### 响应示例 **状态码：200** 请求响应成功。 ``` { "sql_alarm_rules" : [ { "sql_alarm_rule_name" : "tuod**********Test", "is_css_sql" : true, "sql_alarm_rule_id" : "76be********************************673a", "sql_alarm_rule_description" : "", "sql_requests" : [ { "log_stream_id" : "96ec********************************75f", "log_stream_name" : "lts-***********jiqi", "log_group_id" : "38a0********************************d718", "log_group_name" : "lts-**********group", "sql" : "* | SEL***********pv", "sql_request_title" : "", "search_time_range" : 5, "search_time_range_unit" : "minute", "is_time_range_relative" : true, "log_group_name_alias" : "lts-**********group", "log_stream_name_alias" : "lts-***********jiqi" } ], "frequency" : { "type" : "FIXED_RATE", "cron_expr" : "", "hour_of_day" : 0, "day_of_week" : 1, "fixed_rate" : 1, "fixed_rate_unit" : "minute" }, "condition_expression" : "pv > 5", "topics" : [ ], "sql_alarm_level" : "Critical", "domain_id" : "eb71********************************03f", "create_time" : 1779798792856, "update_time" : 1779798792856, "status" : "RUNNING", "whether_recovery_policy" : true, "notification_frequency" : 0, "alarm_action_rule_name" : "Tu*****", "tags" : [ ], "condition_expressions" : [ { "condition_expression" : "pv > 5", "alarm_level" : "Critical" }, { "condition_expression" : "pv > 4", "alarm_level" : "Major" }, { "condition_expression" : "pv > 3", "alarm_level" : "Minor" }, { "condition_expression" : "pv > 2", "alarm_level" : "Info" } ] } ] } ``` **状态码：500** 表明服务端能被请求访问到，但是服务内部出错。 ``` { "error_code" : "LTS.2008", "error_msg" : "Find Alarm rule failed." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求响应成功。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。