获取报警历史详情DescribeAlarmRecord
更新时间：2025-09-04
描述
获取报警历史详情
请求
- 请求语法
Text
1GET /v1/alarm/record?id=${alarmId} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| alarmId | String | Yes | Path | 报警ID |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| alarm | Alarm | 报警记录详情 |
Alarm对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| id | String | 报警ID |
| groupId | String | 分组ID |
| startTime | String | 报警开始时间，UTC时间 |
| endTime | String | 报警关闭时间，UTC时间，若报警未关闭，该值为空字符串 |
| state | String | 报警状态，取值：OK: 已恢复, ALERT: 报警中, CLOSED: 已关闭 |
| closeReason | String | 报警关闭原因， POLICY_MODIFIED: 报警策略更新 |
| policy | Policy | 报警策略详情 |
| object | LogStore | 目标日志集，若执行语句共享目标日志集，该字段填写当前报警关联的目标日志集 |
| triggerCondition | TriggerCondition | 触发报警时的关联的触发条件 |
| groups | Map<String, String> | 分组结果 |
| executions | List<Execution> | 执行列表 |
Policy对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| name | String | 报警策略名称，不能重复 |
| pendingCount | Int | 连续触发阈值，连续多少次触发阈值则报警 |
| repeatIntervalMinute | Int | 重复报警间隔，单位：分钟，默认值：0，表示关闭重复报警 |
| recoverWithoutNotice | Bool | 恢复后是否通知 true：不通知， false：通知, 默认值为false |
| notices | List<Notice> | 报警通知模板，参考：BCM通知模板接口 |
LogStore元素结果如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| project | String | 日志集项目，默认default |
| logStoreName | String | 日志集名称 |
targets数组中的每个Target元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| query | String | 执行语句 |
| startTimeOffsetMinute | Int | 查询开始时间偏移量，取值范围: [-1440, 0) |
| endTimeOffsetMinute | Int | 取值范围: (startTimeOffsetMinute, 0] |
| object | LogStore | 当每个执行语句单独指定日志集时，填写该字段 |
triggerConditions数组中的每个TriggerCondition元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| level | String | 报警等级，必填，可选项：INFO, WARN, CRITICAL |
| condition | String | 触发条件表达式 |
executions数组中的每个Execution元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| time | String | 执行时间，UTC时间 |
| state | String | 执行状态，取值：OK: 恢复正常, ALERT: 报警中 |
| noticeState | String | 通知状态，取值：NOT_SENT: 未通知, SENT: 已通知，FAIL: 通知发送失败 |
| reason | String | 若发送失败，填写失败原因 |
| values | Map<String, Any> | 触发报警时的查询结果数据 |
| notices | List<Notice> | 报警通知模板，参考：BCM通知模板接口 |
| rawLogs | List<RawLog> | 报警通知中原始日志 |
Notice元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 报警模板id |
| name | String | 报警模板名称 |
| members | List<String> | 报警模板用户列表 |
| methods | List<String> | 报警模板通知方式，取值：EMAIL: 邮件，SMS: 短信， PHONE: 电话 |
| callbacks | List<String> | 报警模板回调地址 |
RawLog元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| project | String | 日志集项目 |
| logStoreName | String | 日志集名称 |
| query | String | 查询语句 |
| columns | List<String> | 指定展示字段 |
| limit | Int | 展示的日志条数 |
| logs | List<Map<String, Any>> | 展示的日志原文 |
错误码
除了通用的错误码，无其他特殊错误码返回。
示例
- 请求示例
Text
1GET /v1/alarm/record?id=a-8aab556f3f7b HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8
5{
6 "pageNo": 1,
7 "pageSize": 10
8}- 响应示例
Text
1HTTP/1.1 201
2Content-Type: application/json; charset=utf-8
3X-Bce-Request-Id: 2eeba101-4cc7-4cfe-b5ac-a3be8d060e33
4Date: Fri, 10 Apr 2020 04:42:37 GMT
5{
6 "success": true,
7 "msg": "", // 若失败，返回失败原因
8 "alarm": {
9 "id": "a-8aab556f3f7b", //报警ID
10 "groupId": "Y4gLRiPS", // 分组ID
11 "startTime": "2024-04-10T10:12:30Z", // 报警开始时间，UTC时间
12 "endTime": "2024-04-10T11:21:31Z", // 报警关闭时间，UTC时间，若报警未关闭，该值为空字符串
13
14 // 报警状态，可选项：
15 // OK - 已恢复
16 // ALERT - 报警中
17 // CLOSED - 已关闭
18 "state": "ALERT",
19
20 // 报警关闭原因，可选项：
21 // POLICY_MODIFIED - 报警策略更新
22 "closeReason": "POLICY_MODIFIED",
23
24 // 关联的报警策略
25 "policy": {
26 "name": "policy-name", // 策略名称
27 "pendingCount": 1, // 连续触发阈值，连续多少次触发阈值则报警
28 "notices": [], // 通知列表
29 },
30
31 // 目标日志集，若执行语句共享目标日志集，该字段填写当前报警关联的目标日志集
32 "object": {
33 "logStoreName": "log-store-test", // 日志集名称
34 },
35 // 触发报警时的关联的触发条件
36 "triggerCondition": {
37 // 报警等级，可选项：
38 // INFO - 通知，
39 // WARN - 警告
40 // CRITICAL - 严重
41 "level": "WARN",
42
43 // 触发条件表达式
44 "condition": "$1.pv > 100",
45 },
46 // 分组结果
47 "groups": [
48 {"key": "$1.prov", "value": "bj"},
49 ],
50 // 执行列表
51 "executions": [
52 {
53 "time": "2024-04-10T10:12:30Z", // 执行时间
54
55 // 执行状态，可选项：
56 // ALERT - 报警
57 // OK - 恢复正常可选
58 "state": "ALERT",
59
60 // 通知状态，可选项：
61 // NOT_SENT - 未通知
62 // SENT - 已通知
63 // FAIL - 通知发送失败
64 "noticeState": "SENT",
65 "reason": "", // 若发送失败，填写失败原因
66
67 // 触发报警时的查询结果数据
68 "values": [
69 {"key": "$1.prov", "value": "bj"},
70 {"key": "$1.pv", "value": 1000},
71 ],
72
73 "notices": [
74 {
75 "id": "dfa4298f-75e2-4e17-89f6-d41ea98ea196", // 模板id
76 "name": "默认通知", // 模板名称
77 // 用户列表
78 "members": ["testUsername"],
79 // 通知方式，可选项：
80 // EMAIL - 邮件
81 // SMS - 短信
82 // PHONE - 电话
83 "methods": ["EMAIL", "SMS", "PHONE"],
84 "callbacks": ["http://callback"], // 回调地址列表
85 }
86 ],
87 "rawLogs": [
88 {
89 // 日志集项目
90 "project" : "default",
91 // 日志集名称
92 "logStoreName" : "bls-router",
93 // 查询语句
94 "query" : "match userId:bbede3f8c42e4113b6971fd09a57f494",
95 // 指定展示字段
96 "columns" : ["userId", "requestid", "ip"],
97 //最大日志条数
98 "limit" : 3,
99 // 展示的日志原文
100 "logs" : [
101 {
102 "@timestamp" : 1721898797668,
103 "userId" : "bbede3f8c42e4113b6971fd09a57f494",
104 "requestid" : "a-ZC1Zxpxy",
105 "ip": "127.0.0.1",
106 }
107 ]
108 },
109 {
110 "project" : "default",
111 "logStoreName" : "bls-router",
112 "query" : "match *",
113 "columns" : [], // 若未填写或未空，表示展示全部字段
114 "limit" : 2,
115 "logs" : [],
116 }
117 ]
118 }
119 ]
120 }
121}