获取报警历史详情DescribeAlarmRecord
更新时间:2026-06-23
- 获取报警历史详情。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1GET /v{version}/alarm/record?id=${alarmId} HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为1 |
| alarmId | String | 是 | Query参数 | 报警ID |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码,成功为OK,错误为具体的错误码 |
| message | String | 请求成功为空,失败为具体的错误信息 |
| alarm | Alarm | 报警记录详情 |
请求示例
Plain Text
1GET /v1/alarm/record?id=a-8aab556f3f7b HTTP/1.1
2HOST bls-log.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "msg": "", // 若失败,返回失败原因
11 "alarm": {
12 "id": "a-8aab556f3f7b", //报警ID
13 "groupId": "Y4gLRiPS", // 分组ID
14 "startTime": "2024-04-10T10:12:30Z", // 报警开始时间,UTC时间
15 "endTime": "2024-04-10T11:21:31Z", // 报警关闭时间,UTC时间,若报警未关闭,该值为空字符串
16
17 // 报警状态,可选项:
18 // OK - 已恢复
19 // ALERT - 报警中
20 // CLOSED - 已关闭
21 "state": "ALERT",
22
23 // 报警关闭原因,可选项:
24 // POLICY_MODIFIED - 报警策略更新
25 "closeReason": "POLICY_MODIFIED",
26
27 // 关联的报警策略
28 "policy": {
29 "name": "policy-name", // 策略名称
30 "pendingCount": 1, // 连续触发阈值,连续多少次触发阈值则报警
31 "notices": [], // 通知列表
32 },
33
34 // 目标日志集,若执行语句共享目标日志集,该字段填写当前报警关联的目标日志集
35 "object": {
36 "logStoreName": "log-store-test", // 日志集名称
37 },
38 // 触发报警时的关联的触发条件
39 "triggerCondition": {
40 // 报警等级,可选项:
41 // INFO - 通知,
42 // WARN - 警告
43 // CRITICAL - 严重
44 "level": "WARN",
45
46 // 触发条件表达式
47 "condition": "$1.pv > 100",
48 },
49 // 分组结果
50 "groups": [
51 {"key": "$1.prov", "value": "bj"},
52 ],
53 // 执行列表
54 "executions": [
55 {
56 "time": "2024-04-10T10:12:30Z", // 执行时间
57
58 // 执行状态,可选项:
59 // ALERT - 报警
60 // OK - 恢复正常可选
61 "state": "ALERT",
62
63 // 通知状态,可选项:
64 // NOT_SENT - 未通知
65 // SENT - 已通知
66 // FAIL - 通知发送失败
67 "noticeState": "SENT",
68 "reason": "", // 若发送失败,填写失败原因
69
70 // 触发报警时的查询结果数据
71 "values": [
72 {"key": "$1.prov", "value": "bj"},
73 {"key": "$1.pv", "value": 1000},
74 ],
75
76 "notices": [
77 {
78 "id": "dfa4298f-75e2-4e17-89f6-d41ea98ea196", // 模板id
79 "name": "默认通知", // 模板名称
80 // 用户列表
81 "members": ["testUsername"],
82 // 通知方式,可选项:
83 // EMAIL - 邮件
84 // SMS - 短信
85 // PHONE - 电话
86 "methods": ["EMAIL", "SMS", "PHONE"],
87 "callbacks": ["http://callback"], // 回调地址列表
88 }
89 ],
90 "rawLogs": [
91 {
92 // 日志集项目
93 "project" : "default",
94 // 日志集名称
95 "logStoreName" : "bls-router",
96 // 查询语句
97 "query" : "match userId:bbede3f8c42e4113b6971fd09a57f494",
98 // 指定展示字段
99 "columns" : ["userId", "requestid", "ip"],
100 //最大日志条数
101 "limit" : 3,
102 // 展示的日志原文
103 "logs" : [
104 {
105 "@timestamp" : 1721898797668,
106 "userId" : "bbede3f8c42e4113b6971fd09a57f494",
107 "requestid" : "a-ZC1Zxpxy",
108 "ip": "127.0.0.1",
109 }
110 ]
111 },
112 {
113 "project" : "default",
114 "logStoreName" : "bls-router",
115 "query" : "match *",
116 "columns" : [], // 若未填写或未空,表示展示全部字段
117 "limit" : 2,
118 "logs" : [],
119 }
120 ]
121 }
122 ]
123 }
124}
评价此篇文章
