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

查询关键词告警规则

功能介绍

该接口用于查询关键词告警。

URI

GET /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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

keywords_alarm_rules

Array of KeywordsAlarmRuleRespList objects

项目id

表4 KeywordsAlarmRuleRespList

参数

参数类型

描述

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 KeywordsRequest objects

关键词详细信息

frequency

Frequency object

告警统计周期

keywords_alarm_level

String

告警级别

keywords_alarm_send

Boolean

是否发送

domain_id

String

Domain ID

create_time

Long

创建时间(毫秒时间戳)

update_time

Long

更新时间(毫秒时间戳)

topics

Array of Topics objects

通知主题,即将下线,推荐使用行动规则

template_name

String

消息模板名称

status

String

告警状态

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

告警行动规则名称

id

String

与字段keywords_alarm_rule_id内容相同。

indexId

String

与字段keywords_alarm_rule_id内容相同。

key

String

与字段keywords_alarm_rule_id内容相同。

表5 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

查询时间单位

表6 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

表7 Topics

参数

参数类型

描述

name

String

主题名称。

topic_urn

String

Topic的唯一的资源标识。

display_name

String

Topic的显示名,推送邮件消息时,作为邮件发件人显示。

push_policy

Integer

消息推送的策略。

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

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" : "Alarm Action Rule Name",
    "alarm_rule_alias" : "APITest",
    "condition_expressions" : [ {
      "alarm_level" : "CRITICAL",
      "condition_expression" : "Matching Log Events>1"
    } ],
    "create_time" : 1736498043489,
    "domain_id" : "78ac2cb7c0be4d0482bd7d949830e0b8",
    "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",
    "id" : "025a5375-c548-498c-8330-219cf8a1dbbf",
    "indexId" : "025a5375-c548-498c-8330-219cf8a1dbbf",
    "key" : "025a5375-c548-498c-8330-219cf8a1dbbf",
    "keywords_alarm_rule_description" : "",
    "keywords_alarm_rule_id" : "025a5375-c548-498c-8330-219cf8a1dbbf",
    "keywords_alarm_rule_name" : "APITest",
    "keywords_alarm_send" : true,
    "keywords_requests" : [ {
      "condition" : ">",
      "conditions" : [ {
        "alarm_level" : "CRITICAL",
        "condition" : ">",
        "number" : 1
      } ],
      "eps_id" : "0",
      "is_time_range_relative" : true,
      "keywords" : "aaa",
      "log_group_id" : "b2ead43b-c055-4581-8c13-56af52b6bc13",
      "log_group_name" : "lts-group-mwb002",
      "log_group_name_alias" : "lts-group-mwb002",
      "log_stream_id" : "072795c7-ce92-4ea3-b359-1928d47ab152",
      "log_stream_name" : "lts-topic-coredns",
      "log_stream_name_alias" : "lts-topic-coredns",
      "number" : 1,
      "search_time_range" : 5,
      "search_time_range_unit" : "minute"
    } ],
    "language" : "zh-cn",
    "notification_frequency" : 0,
    "projectId" : "a0a12b069ab4491185d7cf26c3e86ada",
    "query_version" : "v2",
    "query_version_for_query" : "newVersion",
    "recovery_policy" : 3,
    "status" : "RUNNING",
    "tags" : [ {
      "key" : "tagTest",
      "value" : "level"
    } ],
    "topics" : [ ],
    "trigger_condition_count" : 1,
    "trigger_condition_frequency" : 1,
    "update_time" : 1736498043489,
    "whether_recovery_policy" : true
  }, {
    "projectId" : "string",
    "keywords_alarm_rule_id" : "string",
    "keywords_alarm_rule_name" : "string",
    "keywords_alarm_rule_description" : "string",
    "condition_expression" : "string",
    "keywords_requests" : [ {
      "log_stream_id" : "string",
      "log_stream_name" : "string",
      "log_group_id" : "string",
      "log_group_name" : "string",
      "keywords" : "string",
      "condition" : ">=",
      "number" : 1,
      "search_time_range" : 0,
      "search_time_range_unit" : "minute"
    } ],
    "frequency" : {
      "type" : "CRON",
      "cron_expr" : "string",
      "hour_of_day" : 0,
      "day_of_week" : 0,
      "fixed_rate" : 0,
      "fixed_rate_unit" : "minute"
    },
    "keywords_alarm_level" : "Info",
    "keywords_alarm_send" : true,
    "domain_id" : "string",
    "create_time" : 0,
    "update_time" : 0,
    "template_name" : "Message template name.",
    "status" : "RUNNING",
    "trigger_condition_count" : "1",
    "trigger_condition_frequency" : "1",
    "whether_recovery_policy" : false,
    "recovery_policy" : "3",
    "notification_frequency" : 5,
    "alarm_action_rule_name" : "",
    "topics" : [ {
      "name" : "string",
      "topic_urn" : "string",
      "display_name" : "test-smn",
      "push_policy" : 0
    } ]
  } ]
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错。

{
  "error_code" : "LTS.2008",
  "error_msg" : "Find Alarm rule failed."
}

状态码

状态码

描述

200

请求响应成功。

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码