获取报警执行列表ListAlarmExecutions
更新时间：2025-09-04
描述
获取报警执行列表
请求
- 请求语法
Text
1POST /v1/alarm/execution/list HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5{
6 "policyId": "<policyId>"
7}- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| policyId | String | No | RequestBody | 按策略ID过滤 |
| logStoreName | String | No | RequestBody | 按日志集过滤 |
| state | String | No | RequestBody | 按报警状态过滤，取值：OK: 已恢复, ALERT: 报警中, CLOSED: 已关闭 |
| noticeStates | List<String> | No | RequestBody | 按报警通知状态过滤，取值：SENT: 已发送, NOT_SENT: 不发送, FAIL: 发送失败, BLOCK_BY_PENDING_COUNT: 不发送由于频次不足, BLOCK_BY_REPEAT_INTERVAL: 不发送由于重复报警间隔没到, BLOCK_BY_FREQUENCY: 不发送由于发送次数过多, BLOCK_BY_NOTICE_DISABLED: 不发送由于通知关闭 |
| startDateTime | String | No | RequestBody | 查询开始时间，UTC时间，默认值：30天前 |
| endDateTime | String | No | RequestBody | 查询结束时间，UTC时间，默认值：当前时间 |
| orderBy | String | No | RequestBody | 排序字段，@timestamp: 执行时间， 默认值：@timestamp |
| order | String | No | RequestBody | 排序方式，asc: 升序， desc: 降序，默认值：desc |
| pageNo | Int | Yes | RequestBody | 第几页，从1开始计数 |
| pageSize | Int | Yes | RequestBody | 每页展示数量，最大值：100 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| result | Result | 报警记录详情 |
Result对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| executions | List<Execution> | 报警策略列表 |
| pageNo | Int | 第几页 |
| pageSize | Int | 每页展示数量 |
| totalCount | Int | 总数 |
executions数组中的每个Execution元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| time | String | 执行时间，UTC时间 |
| objects | List<LogStore> | 监控对象 |
| state | String | 执行状态，取值：OK: 恢复正常, ALERT: 报警中 |
| noticeState | String | 通知状态，取值：SENT: 已发送, NOT_SENT: 不发送, FAIL: 发送失败, BLOCK_BY_PENDING_COUNT: 不发送由于频次不足, BLOCK_BY_REPEAT_INTERVAL: 不发送由于重复报警间隔没到, BLOCK_BY_FREQUENCY: 不发送由于发送次数过多, BLOCK_BY_NOTICE_DISABLED: 不发送由于通知关闭 |
| reason | String | 若发送失败，填写失败原因 |
| triggerConditions | List<TriggerCondition> | 触发条件列表 |
| groups | List<Map<String, Any>> | 分组触发 |
| values | Map<String, Any> | 触发报警时的查询结果数据 |
| notices | List<Notice> | 报警通知模板，参考：BCM通知模板接口 |
| rawLogs | List<RawLog> | 报警通知中原始日志 |
其中，objects数组中的每个LogStore元素结果如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| project | String | 日志集项目，默认default |
| logStoreName | String | 日志集名称 |
| logStoreId | String | 监控对象ID |
triggerConditions数组中的每个TriggerCondition元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| level | String | 报警等级，必填，可选项：INFO, WARN, CRITICAL |
| condition | String | 触发条件表达式 |
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
1POST /v1/alarm/execution/list 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 result: {
9 // 执行列表
10 "executions": [
11 {
12 "time": "2024-04-10T10:12:30Z", // 执行时间
13
14 // 监控对象
15 "objects": [
16 {
17 // 监控对象ID
18 "logStoreId": "l-P8QD16AB",
19 // 监控对象名称
20 "logStoreName": "wang_test"
21 }
22 ],
23
24 // 执行状态，可选项：
25 // ALERT - 报警
26 // OK - 恢复正常可选
27 // FAIL - 执行失败
28 "state": "ALERT",
29
30 // 通知状态，可选项：
31 // SENT - 发送，
32 // NOT_SENT - 不发送
33 // FAIL - 失败
34 // BLOCK_BY_PENDING_COUNT - 不发送由于频次不足
35 // BLOCK_BY_REPEAT_INTERVAL - 不发送由于重复报警间隔没到
36 // BLOCK_BY_FREQUENCY - 不发送由于发送次数过多
37 // BLOCK_BY_NOTICE_DISABLED - 不发送由于通知关闭
38 "noticeState": "SENT",
39 "reason": "", // 若发送失败，填写失败原因
40
41 // 关联的触发条件
42 "triggerCondition": {
43 // 报警等级，可选项：
44 // INFO - 通知，
45 // WARN - 警告
46 // CRITICAL - 严重
47 "level": "WARN",
48
49 // 触发条件表达式
50 "condition": "$1.age > 1"
51 },
52
53 // 分组结果
54 "groups": [
55 {"key": "$1.prov", "value": "bj"},
56 ],
57
58 // 触发报警时的查询结果数据
59 "values": [
60 {"key": "$1.prov", "value": "bj"},
61 {"key": "$1.pv", "value": 1000},
62 ],
63
64 "notices": [
65 {
66 "id": "dfa4298f-75e2-4e17-89f6-d41ea98ea196", // 模板id
67 "name": "默认通知", // 模板名称
68 // 用户列表
69 "members": ["testUsername"],
70 // 通知方式，可选项：
71 // EMAIL - 邮件
72 // SMS - 短信
73 // PHONE - 电话
74 "methods": ["EMAIL", "SMS", "PHONE"],
75 "callbacks": ["http://callback"], // 回调地址列表
76 // 屏蔽时间
77 "disableTimes": [
78 {
79 // 开始时间
80 "from": "00:00:00",
81 // 结束时间
82 "to": "00:00:00"
83 }
84 ]
85 }
86 ]
87 }
88 ],
89 "pageNo": 1, // 第几页
90 "pageSize": 10, // 每页展示数量
91 "totalCount": 100, // 总数
92 }
93}