获取报警历史列表ListAlarmRecord
更新时间:2026-06-23
- 获取报警历史列表。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/alarm/record/list HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "pageNo": <pageNo>,
7 "pageSize": <pageSize>,
8 "policyNamePattern": <policyNamePattern>,
9 "policyIdPattern": <policyIdPattern>,
10 "logStoreNamePattern": <logStoreNamePattern>,
11 "level": <level>,
12 "state": <state>,
13 "startDateTime": <startDateTime>,
14 "endDateTime": <endDateTime>,
15 "orderBy": <orderBy>,
16 "order": <order>
17}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为1 |
| policyNamePattern | String | 否 | RequestBody参数 | 按策略名称过滤 |
| policyIdPattern | String | 否 | RequestBody参数 | 按策略ID过滤 |
| logStoreNamePattern | String | 否 | RequestBody参数 | 按日志集过滤 |
| level | String | 否 | RequestBody参数 | 按报警等级过滤, 取值:INFO, WARN, CRITICAL |
| state | String | 否 | RequestBody参数 | 按报警状态过滤,取值:OK: 已恢复, ALERT: 报警中, CLOSED: 已关闭 |
| startDateTime | String | 否 | RequestBody参数 | 查询开始时间,UTC时间,默认值:30天前 |
| endDateTime | String | 否 | RequestBody参数 | 查询结束时间,UTC时间,默认值:当前时间 |
| orderBy | String | 否 | RequestBody参数 | 排序字段,startTime: 报警开始时间, endTime: 报警结束时间,默认值:startTime |
| order | String | 否 | RequestBody参数 | 排序方式,asc: 升序, desc: 降序,默认值:desc |
| pageNo | Int | 是 | RequestBody参数 | 第几页,从1开始计数 |
| pageSize | Int | 是 | RequestBody参数 | 每页展示数量,最大值:100 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码,成功为OK,错误为具体的错误码 |
| message | String | 请求成功为空,失败为具体的错误信息 |
| result | AlarmRecordsResult | 报警记录详情 |
请求示例
Plain Text
1POST /v1/alarm/record/list 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
4
5{
6 "pageNo": 1,
7 "pageSize": 10,
8 "policyNamePattern": "policyName1",
9 "policyIdPattern": "id1",
10 "logStoreNamePattern": "logstoreName1",
11 "level": "INFO",
12 "state": "ALERT",
13 "startDateTime": "2024-04-10T10:12:30Z",
14 "endDateTime": "2024-04-17T10:12:30Z",
15 "orderBy": "startTime",
16 "order": "desc"
17}
响应示例
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 "result": {
12 // 报警列表
13 "alarms": [
14 {
15 "id": "a-8aab556f3f7b", //报警ID
16 "groupId": "Y4gLRiPS", // 分组ID
17 "startTime": "2024-04-10T10:12:30Z", // 报警开始时间,UTC时间
18 "endTime": "2024-04-10T11:21:31Z", // 报警关闭时间,UTC时间,若报警未关闭,该值为空字符串
19 // 报警状态,可选项:
20 // OK - 已恢复
21 // ALERT - 报警中
22 // CLOSED - 已关闭
23 "state": "ALERT",
24 // 报警关闭原因,可选项:
25 // POLICY_MODIFIED - 报警策略更新
26 "closeReason": "POLICY_MODIFIED",
27 // 关联的报警策略
28 "policy": {
29 "name": "policy-name", // 策略名称
30 // 执行语句列表
31 "targets": [
32 {
33 // 执行语句
34 "query": "select sum(age) as age",
35 // 查询开始时间偏移量,取值范围: [-1440, 0)
36 "startTimeOffsetMinute": -1440,
37 // 查询结束时间偏移量,取值范围: (startTimeOffsetMinute, 0]
38 "endTimeOffsetMinute": 0,
39 // 目标日志集,若每个执行语句单独指定日志集,填写该字段
40 "object": {
41 "logStoreName": "test-logstore-52" // 日志集名称
42 }
43 }
44 ],
45 },
46 // 关联的触发条件
47 "triggerCondition": {
48 // 报警等级,可选项:
49 // INFO - 通知,
50 // WARN - 警告
51 // CRITICAL - 严重
52 "level": "WARN",
53 // 触发条件表达式
54 "condition": "$1.age > 1"
55 },
56 // 目标日志集,若执行语句共享目标日志集,该字段填写当前报警关联的目标日志集
57 "object": {
58 "logStoreName": "log-store-test", // 日志集名称
59 },
60 // 分组结果
61 "groups": [
62 {
63 "key": "$1.prov",
64 "value": "bj"
65 },
66 ],
67 // 上一次通知时间,UTC时间,若未发生通知,则改字段为空字符串
68 "lastNoticeTime": "2024-04-10T11:21:31Z",
69 // 触发报警时的通知详情
70 "notices": [
71 {
72 "id": "dfa4298f-75e2-4e17-89f6-d41ea98ea196", // 模板id
73 "name": "默认通知", // 模板名称
74 "members": [
75 "testUsername"
76 ], // 用户列表
77 // 通知方式,可选项:
78 // EMAIL - 邮件
79 // SMS - 短信
80 // PHONE - 电话
81 "methods": [
82 "EMAIL",
83 "SMS",
84 "PHONE"
85 ],
86 "callbacks": [
87 "http://callback"
88 ] // 回调地址
89 }
90 ]
91 }
92 ],
93 "pageNo": 1, // 第几页
94 "pageSize": 10, // 每页展示数量
95 "totalCount": 100 // 总数
96 }
97}
评价此篇文章
