获取报警策略列表ListAlarmPolicy
更新时间:2026-06-23
- 获取报警策略列表。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/alarm/policy/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 "state": <state>,
12 "noticeState": <noticeState>,
13 "orderBy": <orderBy>,
14 "order": <order>
15}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为1 |
| policyNamePattern | String | 否 | RequestBody参数 | 按策略名称过滤 |
| policyIdPattern | String | 否 | RequestBody参数 | 按策略ID过滤 |
| logStoreNamePattern | String | 否 | RequestBody参数 | 按日志集过滤 |
| state | String | 否 | RequestBody参数 | 按策略状态过滤, 取值:ENABLE, DISABLED |
| noticeState | String | 否 | RequestBody参数 | 按通知状态过滤,取值:ENABLE, DISABLED |
| orderBy | String | 否 | RequestBody参数 | 排序字段,createdTime: 创建时间, updatedTime: 更新时间,默认值:updatedTime |
| order | String | 否 | RequestBody参数 | 排序方式,asc: 升序, desc: 降序,默认值:desc |
| pageNo | Int | 是 | RequestBody参数 | 第几页,从1开始计数 |
| pageSize | Int | 是 | RequestBody参数 | 每页展示数量,最大值:100 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码,成功为OK,错误为具体的错误码 |
| message | String | 请求成功为空,失败为具体的错误信息 |
| result | PolicyListResult | 报警策略详情 |
请求示例
Plain Text
1POST /v1/alarm/policy/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": "p1",
9 "policyIdPattern": "pid1",
10 "logStoreNamePattern": "name1",
11 "state": "ENABLE",
12 "noticeState": "ENABLE",
13 "orderBy": "createdTime",
14 "order": "desc"
15}
响应示例
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 "code": "OK", // 错误码
11 "message": "", // 错误详情
12 "result": {
13 "pageNo": 1, // 第几页
14 "pageSize": 10, // 每页展示数量
15 "totalCount": 100, // 总数
16 "policies": {
17 // 报警策略名称,同user下唯一
18 "name": "policy-name",
19
20 // 策略ID,同user下唯一
21 "id": "p-nRyKJOpr",
22
23 // 策略启用状态,可选项:
24 // ENABLED - 已启用
25 // DISABLED - 已禁用
26 "state": "ENABLED",
27
28 // 通知启用状态,可选项:
29 // ENABLED - 已启用
30 // DISABLED - 已禁用
31 "noticeState": "ENABLED",
32
33 // 通知启用状态,可选项
34 // ENABLED - 已启用
35 // DISABLED - 已禁用
36 "noticeState": "ENABLED",
37
38 "createdTime": "20240410T10:12:30Z", // 创建时间,UTC时间
39 "updatedTime": "20240410T10:12:30Z", // 更新时间,UTC时间
40
41 // 监控对象列表,当所有日志集共享目标日志集时,该字段被填充
42 "objects": [
43 {
44 "logStoreName": "test-logstore-52" // 日志集名称
45 },
46 ],
47
48 // 执行语句列表
49 "targets": [
50 {
51 // 执行语句
52 "query": "select sum(age) as age",
53 // 查询开始时间偏移量,必填,取值范围: [-1440, 0)
54 "startTimeOffsetMinute": -1440,
55 // 查询结束时间偏移量,必填,取值范围: (startTimeOffsetMinute, 0]
56 "endTimeOffsetMinute": 0,
57
58 // 目标日志集,当每个执行语句单独指定日志集时,该字段被填充
59 "object": {
60 "logStoreName": "test-logstore-52" // 日志集名称
61 }
62 }
63 ],
64
65 // 触发条件列表
66 "triggerConditions": [
67 {
68 // 报警等级,可选项:
69 // INFO - 通知,
70 // WARN - 警告
71 // CRITICAL - 严重
72 "level": "WARN",
73
74 // 触发条件表达式
75 "condition": "$1.age > 1"
76 }
77 ],
78
79 // 分组触发
80 "groups": ["$1.age", "$1.salary"],
81
82 // 执行周期,固定间隔和指定时刻有且仅有一个被设置
83 "schedule": {
84 // 固定间隔,单位:分钟,取值范围[1, 1440]
85 "intervalMinute": 1,
86
87 // 指定时刻,一天中的第几分钟,取值范围[0, 1440)
88 "fixTimeMinute": 120, // 示例中,120表示一天中的第120分钟,即凌晨2点整
89
90 // 固定时间频率; 0: 每天 1~7 一周的周一到周日
91 "dayOfWeek": 3,
92 },
93
94 // 连续触发阈值,连续多少次触发阈值则报警
95 "pendingCount": 1,
96
97 // 重复报警间隔,单位:分钟,默认值:0,表示关闭重复报警
98 "repeatIntervalMinute": 5,
99
100 // 恢复后是否通知 true:通知, false:不通知, 默认
101 "recoverAlarmNotice": true,
102
103 // 报警通知模板列表
104 "notices": [
105 {
106 // bcm报警模板id
107 "id": "testNotice"
108 }
109 ],
110
111 // 报警内容是否增加日志原文 false:不增加,默认 true:增加
112 "noticeWithRawLog" : true,
113
114 // 报警通知内容配置
115 "noticeRawConfigs" : [
116 {
117 // 配置类型,必填
118 // REF 自动关联执行语句
119 // CUSTOM 自定义检索语句
120 "type" : "CUSTOM",
121
122 // 若type为REF,表示执行语句序号
123 "refTarget" : 1,
124
125 // 若type为AUTO_ASSOCIATED,表示自定义检索语句
126 "query" : "match *",
127
128 // 如果每个执行语句单独选择日志集,且配置为自定义检索语句,这里表示日志集
129 "object" : {
130 // 日志集项目,必填
131 "project" : "default",
132 // 日志集名,必填
133 "logStoreName" : "bls-ng-log"
134 },
135 // 显示字段,必填写
136 // All - 所有字段
137 // SpecifiedFields - 指定字段
138 "displayType" : "ALL",
139
140 // 指定字段名列表,选填
141 "display_fields" : ["requestid", "status"],
142 // 表示展示的日志条数,最大值为5
143 "limit" : 4,
144 }
145 ]
146 }
147 }
148}
评价此篇文章
