更新时间:2024-01-09 GMT+08:00
分享

查询SQL告警规则

功能介绍

该接口用于查询SQL告警

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

缺省值:None

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

缺省值:None

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

缺省值:None

最小长度:30

最大长度:30

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

sql_alarm_rules

Array of SqlAlarmRuleRespList objects

SQL告警

表4 SqlAlarmRuleRespList

参数

参数类型

描述

sql_alarm_rule_name

String

SQL告警名称

最小长度:1

最大长度:64

is_css_sql

Boolean

是否管道符sql查询

缺省值:false

sql_alarm_rule_id

String

SQL告警规则id

最小长度:36

最大长度:36

sql_alarm_rule_description

String

SQL告警信息描述

最小长度:0

最大长度:64

sql_requests

Array of SqlRequest objects

SQL详细信息

frequency

FrequencyRespBody object

告警统计周期

condition_expression

String

条件表达式

最小长度:1

最大长度:1024

topics

Array of Topics objects

主题信息

sql_alarm_level

String

告警级别

枚举值:

  • Info

  • Minor

  • Major

  • Critical

sql_alarm_send

Boolean

是否发送

domain_id

String

domainId

最小长度:32

最大长度:32

create_time

Long

创建时间(毫秒时间戳)

最小值:13

最大值:13

update_time

Long

更新时间(毫秒时间戳)

最小值:13

最大值:13

template_name

String

消息模板名称

status

String

告警状态

枚举值:

  • RUNNING 启用

  • STOPPING 停止

trigger_condition_count

Integer

触发条件:触发周期;默认为1

trigger_condition_frequency

Integer

触发条件:触发周期;默认为1

whether_recovery_policy

Boolean

是否打开恢复通知;默认false

recovery_policy

Integer

恢复策略周期;默认为3

notification_frequency

Integer

通知频率,单位(分钟)

枚举值:

  • 0

  • 5

  • 10

  • 15

  • 30

  • 60

  • 180

  • 360

alarm_action_rule_name

String

告警行动规则名称

说明:

alarm_action_rule_name和notification_save_rule可以选填一个,如果都填,优先选择alarm_action_rule_name

表5 SqlRequest

参数

参数类型

描述

is_time_range_relative

Boolean

是时间范围相对

log_stream_id

String

日志流id

最小长度:36

最大长度:36

log_stream_name

String

日志流名称

最小长度:1

最大长度:64

log_group_id

String

日志组id

最小长度:36

最大长度:36

log_group_name

String

日志组名称

最小长度:1

最大长度:64

sql

String

sql语句

最小长度:1

最大长度:1024

sql_request_title

String

图表名称

最小长度:1

最大长度:64

search_time_range

Integer

查询执行任务时最近数据的时间范围(当search_time_range_unit为minute,则最大值为60;当search_time_range_unit为hour,则最大值为24)

最小值:1

最大值:60

search_time_range_unit

String

查询时间单位

枚举值:

  • minute

  • hour

表6 FrequencyRespBody

参数

参数类型

描述

type

String

时间类型。

枚举值:

  • CRON

  • HOURLY

  • DAILY

  • WEEKLY

  • FIXED_RATE

cron_expr

String

当字段type为"CRON"时取该字段。

最小长度:1

最大长度:1024

hour_of_day

Integer

当字段type为"DAILY"或者"WEEKLY"时取该字段。

day_of_week

Integer

当字段type为"WEEKLY"时取该字段(周日~周六)。

fixed_rate

Integer

当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24)。

fixed_rate_unit

String

时间单位枚举值:

枚举值:

  • minute

  • hour

表7 Topics

参数

参数类型

描述

name

String

主题名称。

最小长度:1

最大长度:1024

topic_urn

String

Topic的唯一的资源标识。

最小长度:1

最大长度:1024

display_name

String

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

最小长度:1

最大长度:1024

push_policy

Integer

消息推送的策略。

最小值:1

最大值:1024

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

枚举值:

  • Invalid projectId

请求示例

查询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",
    "topics" : [ {
      "name" : "string",
      "topic_urn" : "string",
      "display_name" : "string",
      "push_policy" : 0
    } ],
    "sql_alarm_level" : "Info",
    "sql_alarm_send" : true,
    "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

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

错误码

请参见错误码

分享:

    相关文档

    相关产品