更新时间:2025-08-20 GMT+08:00

查询SQL告警规则

功能介绍

该接口用于查询SQL告警

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/lts/alarms/sql-alarm-rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

sql_alarm_rules

Array of SqlAlarmRuleRespList objects

参数解释:

SQL告警规则信息。

表4 SqlAlarmRuleRespList

参数

参数类型

描述

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

参数解释:

告警状态。

取值范围:

  • 触发

  • 恢复

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

  • 630

alarm_action_rule_name

String

参数解释:

告警行动规则名称。

取值范围:

不涉及。

tags

Array of tagsResBody objects

参数解释:

告警标签信息。

表5 SqlRequestResponse

参数

参数类型

描述

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

表6 FrequencyRespBody

参数

参数类型

描述

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

表7 Topics

参数

参数类型

描述

name

String

参数解释:

SMN主题名称。

取值范围:

不涉及。

topic_urn

String

参数解释:

SMN主题的唯一的资源标识。

取值范围:

不涉及。

display_name

String

参数解释:

发送邮件时,显示的发件人名称。。

取值范围:

不涉及。

push_policy

Integer

参数解释:

消息推送的策略,该属性目前不支持修改,后续将支持修改。

取值范围:

  • 0:发送失败,保留到失败队列。

  • 1:直接丢弃发送失败的消息。

表8 tagsResBody

参数

参数类型

描述

key

String

参数解释:

标签键。

取值范围:

不涉及。

value

String

参数解释:

标签值。

取值范围:

不涉及。

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

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" : "string",
    "is_css_sql" : false,
    "sql_alarm_rule_id" : "string",
    "sql_alarm_rule_description" : "string",
    "sql_requests" : [ {
      "log_stream_id" : "string",
      "log_stream_name" : "string",
      "log_group_id" : "string",
      "log_group_name" : "string",
      "sql" : "string",
      "sql_request_title" : "string",
      "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"
    },
    "condition_expression" : "string",
    "sql_alarm_level" : "Info",
    "domain_id" : "string",
    "create_time" : 0,
    "update_time" : 0,
    "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" : ""
  } ]
}

状态码:500

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

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

状态码

状态码

描述

200

请求响应成功。

500

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

错误码

请参见错误码