查询关键词告警规则
功能介绍
该接口用于查询关键词告警。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/lts/alarms/keywords-alarm-rule
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token，获取方式请参见：获取用户Token |
|
Content-Type |
是 |
String |
该字段填为：application/json;charset=UTF-8。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
keywords_alarm_rules |
Array of KeywordsAlarmRuleRespList objects |
项目id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
domainId |
|
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 |
告警行动规则名称
说明：
alarm_action_rule_name和notification_save_rule可以选填一个，如果都填，优先选择alarm_action_rule_name |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
log_stream_id |
String |
日志流id |
|
log_stream_name |
String |
日志流名称 |
|
log_group_id |
String |
日志组id |
|
log_group_name |
String |
日志组名称 |
|
keywords |
String |
关键词 |
|
condition |
String |
条件 |
|
number |
Integer |
行数 |
|
search_time_range |
Integer |
查询执行任务时最近数据的时间范围，最大值为60 minute：最小值：1；最大值：60 hour：最小值：1；最大值：24 |
|
search_time_range_unit |
String |
查询时间单位 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
时间类型。 |
|
cron_expr |
String |
当字段type为"CRON"时取该字段。 |
|
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单位为minute，最大值60；当fixed_rate_unit单位为hour，最大值24，最小值5）。 |
|
fixed_rate_unit |
String |
时间单位。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
主题名称。 |
|
topic_urn |
String |
Topic的唯一的资源标识。 |
|
display_name |
String |
Topic的显示名，推送邮件消息时，作为邮件发件人显示。 |
|
push_policy |
Integer |
消息推送的策略。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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" : [ {
"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" : "消息模板名称",
"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" : "string",
"push_policy" : 0
} ]
} ]
}
状态码： 500
表明服务端能被请求访问到，但是服务内部出错。
{
"error_code" : "LTS.2008",
"error_msg" : "Find Alarm rule failed."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求响应成功。 |
|
500 |
表明服务端能被请求访问到，但是服务内部出错。 |
错误码
请参见错误码。
