# 查询关键词告警规则 - ListKeywordsAlarmRules #### 功能介绍 该接口用于查询关键词告警。 #### 调用方法 请参见[如何调用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:listWordAlarmRule | List | - | - | - | - | #### URI GET /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。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | keywords_alarm_rules | Array of [KeywordsAlarmRuleRespList] objects | **参数解释：** 关键词告警规则ID。 | 表4KeywordsAlarmRuleRespList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | projectId | String | **参数解释：** 项目ID。 **取值范围：** 不涉及。 | | keywords_alarm_rule_id | String | **参数解释：** 关键词告警规则ID。 **取值范围：** 不涉及。 | | keywords_alarm_rule_name | String | **参数解释：** 关键词告警规则名称。 **取值范围：** 不涉及。 | | keywords_alarm_rule_description | String | **参数解释：** 关键词告警规则的简要描述。 **取值范围：** 不涉及。 | | condition_expression | String | **参数解释：** 告警条件表达式。 **取值范围：** 不涉及。 | | keywords_requests | Array of [KeywordsRequestResponse] objects | **参数解释：** 关键词告警规则信息。 | | frequency | [FrequencyRespBody] object | **参数解释：** 关键词告警统计周期信息。 | | keywords_alarm_level | String | **参数解释：** 关键词告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | | domain_id | String | **参数解释：** 账号ID，获取方式请参见：[获取账号ID](https://support.huaweicloud.com/api-lts/lts_api_0012.html)。 **取值范围：** 不涉及。 | | create_time | Long | **参数解释：** 创建时间(毫秒时间戳)。 **取值范围：** 不涉及。 | | update_time | Long | **参数解释：** 更新时间(毫秒时间戳)。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 关键词告警状态。 **取值范围：** - RUNNING (开启) - STOPPING (关闭) | | trigger_condition_count | Integer | **参数解释：** 告警触发条件：满足条件次数。 **取值范围：** 不涉及。 | | trigger_condition_frequency | Integer | **参数解释：** 告警触发条件：统计周期次数。 **取值范围：** 不涉及。 | | whether_recovery_policy | Boolean | **参数解释：** 是否配置告警恢复策略。 **取值范围：** - true：配置告警恢复策略。 - false：不配置告警恢复策略。 | | recovery_policy | Integer | **参数解释：** 告警恢复策略周期次数。 **取值范围：** 1-10 | | notification_frequency | Integer | **参数解释：** 关键词告警通知频率，单位(分钟)。 **取值范围：** - 0 - 5 - 10 - 15 - 30 - 60 - 180 - 360 | | alarm_action_rule_name | String | **参数解释：** 告警行动规则名称。 **取值范围：** 不涉及。 | | tags | Array of [tagsResBody] objects | **参数解释：** 告警标签信息。标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 | 表5KeywordsRequestResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 时间范围配置。 | 表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 | 表7KeywordsAlarmConditions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | condition | String | **参数解释：** 触发条件，即满足该条件时，会触发告警。 **取值范围：** 不涉及。 | | number | Integer | **参数解释：** 匹配条数。当关键词搜索结果的日志条数达到设定的条数时，会触发告警。 **取值范围：** 不涉及。 | | alarm_level | String | **参数解释：** 告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | 表8TimeRange | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：不包含结束时间点。 | 表9FrequencyRespBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表10tagsResBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 标签值。 **取值范围：** 不涉及。 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 查询关键词告警规则。 ``` GET https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule /v2/{project_id}/lts/alarms/keywords-alarm-rule ``` #### 响应示例 **状态码：200** 请求响应成功。 ``` { "keywords_alarm_rules" : [ { "alarm_action_rule_name" : "m***y", "alarm_rule_alias" : "test_alias", "closed_alarm_time" : 0, "condition_expression" : "Matching Log Events>1", "condition_expressions" : [ { "alarm_level" : "Info", "condition_expression" : "Matching Log Events>1" } ], "create_time" : 1705412189478, "domain_id" : "78ac****e0b8", "enterprise_project_id" : "--", "frequency" : { "cron_expr" : "", "day_of_week" : 1, "fixed_rate" : 1, "fixed_rate_unit" : "minute", "hour_of_day" : 0, "type" : "FIXED_RATE" }, "keywords_alarm_level" : "Info", "keywords_alarm_rule_description" : "", "keywords_alarm_rule_id" : "f013****1379", "keywords_alarm_rule_name" : "test", "keywords_alarm_send" : false, "keywords_requests" : [ { "condition" : ">", "conditions" : [ { "alarm_level" : "Info", "condition" : ">", "number" : 1 } ], "custom_date" : { "end" : 0, "end_unit" : "minute", "start" : 1, "start_unit" : "minute" }, "eps_id" : "", "is_time_range_relative" : true, "keywords" : "Chinese : 北京是中国首都 AND (NOT Num : 12 AND NOT Num : 20 OR (Num : 100 AND Chinese2 : eng*))", "log_group_id" : "a5a07c50-****-410f-****-76801b73292d", "log_group_name" : "lts-query-***", "log_group_name_alias" : "lts-query-***", "log_stream_id" : "4fc9217a-****-4dd2-****-bc5251a869d7", "log_stream_name" : "0.3kpython", "log_stream_name_alias" : "0.3kpython", "number" : 1, "search_time_range" : 1, "search_time_range_unit" : "minute", "time_range" : null } ], "notification_frequency" : 0, "projectId" : "a0a12b0*******185d7cf26c3e86ada", "recovery_policy" : 3, "status" : "STOPPING", "tags" : [ ], "template_name" : "", "timezone" : "", "trigger_condition_count" : 1, "trigger_condition_frequency" : 1, "update_time" : 1725089574023, "whether_recovery_policy" : true } ] } ``` **状态码：500** 表明服务端能被请求访问到，但是服务内部出错。 ``` { "error_code" : "LTS.2008", "error_msg" : "Find Alarm rule failed." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求响应成功。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。