获取报警执行统计ListAlarmExecutionStats
更新时间: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过滤 |
policyName | String | No | RequestBody | 按策略名称过滤 |
logStoreName | String | No | RequestBody | 按日志集过滤 |
startDateTime | String | No | RequestBody | 查询开始时间,UTC时间,默认值:30天前 |
endDateTime | String | No | RequestBody | 查询结束时间,UTC时间,默认值:当前时间 |
orderBy | String | No | RequestBody | 排序字段,totalCount: 执行次数, failCount:执行失败次数, noticeTotalCount: 通知次数, noticeFailCount:通知失败次数 |
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对象的元素结构如下:
字段 | 类型 | 描述 |
---|---|---|
executionStats | List<executionStats> | 报警策略列表 |
pageNo | Int | 第几页 |
pageSize | Int | 每页展示数量 |
totalCount | Int | 总数 |
executionStats数组中的每个ExecutionStats元素结构如下:
参数名称 | 类型 | 描述 |
---|---|---|
policyId | String | 报警策略ID |
policyName | String | 报警策略名称 |
objects | List<LogStore> | 监控对象 |
pendingCount | Int | 连续触发阈值,连续多少次触发阈值则报警 |
repeatIntervalMinute | Int | 重复报警间隔,单位:分钟,默认值:0,表示关闭重复报警 |
notices | List<Notice> | 报警通知模板,参考:BCM通知模板接口 |
totalCount | Int | 执行次数 |
failCount | Int | 执行失败次数 |
noticeTotalCount | Int | 通知次数 |
noticeFailCount | Int | 通知失败次数 |
其中,objects数组中的每个LogStore元素结果如下:
字段 | 类型 | 描述 |
---|---|---|
project | String | 日志集项目,默认default |
logStoreName | String | 日志集名称 |
logStoreId | String | 监控对象ID |
Notice元素结构如下:
参数名称 | 类型 | 描述 |
---|---|---|
id | String | 报警模板id |
name | String | 报警模板名称 |
members | List<String> | 报警模板用户列表 |
methods | List<String> | 报警模板通知方式,取值:EMAIL: 邮件,SMS: 短信, PHONE: 电话 |
callbacks | List<String> | 报警模板回调地址 |
disableTimes | List<Map<String, String>> | 屏蔽时间 |
错误码
除了通用的错误码,无其他特殊错误码返回。
示例
- 请求示例
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 "executionStats": [
11 {
12 "policyId": "x-aaaa", // 策略ID
13 "policyName": "test", // 策略名称
14 // 监控对象
15 "objects": [
16 {
17 // 监控对象ID
18 "logStoreId": "l-P8QD16AB",
19 // 监控对象名称
20 "logStoreName": "wang_test"
21 }
22 ],
23 // 连续触发阈值,连续多少次触发阈值则报警
24 "pendingCount": 1,
25 // 重复报警间隔,单位:分钟,默认值:0,表示关闭重复报警
26 "repeatIntervalMinute": 5,
27 // 通知列表
28 "notices": [
29 {
30 "id": "dfa4298f-75e2-4e17-89f6-d41ea98ea196", // 模板id
31 "name": "默认通知", // 模板名称
32 // 用户列表
33 "members": ["testUsername"],
34 // 通知方式,可选项:
35 // EMAIL - 邮件
36 // SMS - 短信
37 // PHONE - 电话
38 "methods": ["EMAIL", "SMS", "PHONE"],
39 "callbacks": ["http://callback"], // 回调地址列表
40 // 屏蔽时间
41 "disableTimes": [
42 {
43 // 开始时间
44 "from": "00:00:00",
45 // 结束时间
46 "to": "00:00:00"
47 }
48 ]
49 }
50 ],
51 // 执行次数
52 "totalCount": 10,
53 // 执行失败次数
54 "failCount": 1,
55 // 通知次数
56 "noticeTotalCount": 5,
57 // 通知失败次数
58 "noticeFailCount": 1
59 }
60 ],
61 "pageNo": 1, // 第几页
62 "pageSize": 10, // 每页展示数量
63 "totalCount": 100, // 总数
64 }
65}