获取报警策略详情DescribeAlarmPolicy
更新时间：2025-09-04
描述
获取报警策略详情
请求
- 请求语法
Text
1GET /v1/alarm/policy?name=${PolicyName} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| PolicyName | String | Yes | Path | 报警策略名称 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| policy | Policy | 报警策略详情 |
Policy对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| id | String | 报警策略ID，唯一 |
| name | String | 报警策略名称，不能重复 |
| objects | List<LogStore> | 监控对象列表，当所有日志集共享目标日志集时，填写该字段 |
| targets | List<Target> | 执行语句列表 |
| triggerConditions | List<TriggerCondition> | 触发条件列表 |
| groups | List<String> | 分组触发 |
| schedule | Schedule | 执行周期 |
| pendingCount | Int | 连续触发阈值，连续多少次触发阈值则报警 |
| repeatIntervalMinute | Int | 重复报警间隔，单位：分钟，默认值：0，表示关闭重复报警 |
| recoverWithoutNotice | Bool | 恢复后是否通知 true：不通知， false：通知, 默认值为false |
| state | String | 策略启用状态，ENABLED: 已启用， DISABLED: 已禁用 |
| noticeState | String | 下通知启用状态，ENABLED: 已启用， DISABLED: 已禁用 |
| notices | List<Notice> | 报警通知模板，参考：BCM通知模板接口 |
| noticeRawLogs | List<NoticeRawLog> | 是否在报警通知中添加原始日志 |
其中，objects数组中的每个LogStore元素结果如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| project | String | 日志集项目，默认default |
| logStoreName | String | 日志集名称 |
targets数组中的每个Target元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| query | String | 执行语句 |
| startTimeOffsetMinute | Int | 查询开始时间偏移量，取值范围: [-1440, 0) |
| endTimeOffsetMinute | Int | 取值范围: (startTimeOffsetMinute, 0] |
| object | LogStore | 当每个执行语句单独指定日志集时，填写该字段 |
triggerConditions数组中的每个TriggerCondition元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| level | String | 报警等级，必填，可选项：INFO, WARN, CRITICAL |
| condition | String | 触发条件表达式 |
Schedule元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| intervalMinute | Int | 固定间隔，单位：分钟，取值范围[1, 1440] |
| fixTimeMinute | Int | 指定时刻，一天中的第几分钟，取值范围[0, 1440) |
| dayOfWeek | Int | 固定时间频率; 0: 每天，1~7 一周的某天 |
Notice元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | bcm报警模板id |
NoticeRawLog元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | String | 配置类型, REF: 关联执行语句, CUSTOM: 自定义检索语句 |
| refTarget | String | 若type=REF，表示引用的执行语句序号，从0开始计数 |
| customTarget | Target | 若type=CUSTOM，填写自定义执行语句 |
| columns | List<String> | 在原始日志中展示的字段名列表，若未填写，表示展示所有字段 |
| limit | Int | 展示的日志条数，最大值为5 |
错误码
除了通用的错误码，还可能出现如下错误码：
| 错误码 | 错误消息 | 描述 | HTTP状态码 |
|---|---|---|---|
| AlarmPolicyNotFound | AlarmPolicy not found | 报警策略不存在 | 404 |
示例
- 请求示例
Text
1GET /v1/alarm/policy?name=policy-name 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- 响应示例
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 "code": "OK", // 错误码
8 "message": "", // 错误详情
9 "policy": {
10 // 报警策略名称，同user下唯一
11 "name": "policy-name",
12
13 // 策略ID，同user下唯一
14 "id": "p-nRyKJOpr",
15
16 // 策略启用状态，可选项：
17 // ENABLED - 已启用
18 // DISABLED - 已禁用
19 "state": "ENABLED",
20
21 // 通知启用状态，可选项：
22 // ENABLED - 已启用
23 // DISABLED - 已禁用
24 "noticeState": "ENABLED",
25
26 // 通知启用状态，可选项
27 // ENABLED - 已启用
28 // DISABLED - 已禁用
29 "noticeState": "ENABLED",
30
31 "createdTime": "20240410T10:12:30Z", // 创建时间，UTC时间
32 "updatedTime": "20240410T10:12:30Z", // 更新时间，UTC时间
33
34 // 监控对象列表，当所有日志集共享目标日志集时，该字段被填充
35 "objects": [
36 {
37 "logStoreName": "test-logstore-52" // 日志集名称
38 },
39 ],
40
41 // 执行语句列表
42 "targets": [
43 {
44 // 执行语句
45 "query": "select sum(age) as age",
46 // 查询开始时间偏移量，必填，取值范围: [-1440, 0)
47 "startTimeOffsetMinute": -1440,
48 // 查询结束时间偏移量，必填，取值范围: (startTimeOffsetMinute, 0]
49 "endTimeOffsetMinute": 0,
50
51 // 目标日志集，当每个执行语句单独指定日志集时，该字段被填充
52 "object": {
53 "logStoreName": "test-logstore-52" // 日志集名称
54 }
55 }
56 ],
57
58 // 触发条件列表
59 "triggerConditions": [
60 {
61 // 报警等级，可选项：
62 // INFO - 通知，
63 // WARN - 警告
64 // CRITICAL - 严重
65 "level": "WARN",
66
67 // 触发条件表达式
68 "condition": "$1.age > 1"
69 }
70 ],
71
72 // 分组触发
73 "groups": ["$1.age", "$1.salary"],
74
75 // 执行周期，固定间隔和指定时刻有且仅有一个被设置
76 "schedule": {
77 // 固定间隔，单位：分钟，取值范围[1, 1440]
78 "intervalMinute": 1，
79
80 // 指定时刻，一天中的第几分钟，取值范围[0, 1440)
81 "fixTimeMinute": 120， // 示例中，120表示一天中的第120分钟，即凌晨2点整
82
83 // 固定时间频率; 0: 每天 1~7 一周的周一到周日
84 "dayOfWeek": 3,
85 },
86
87 // 连续触发阈值，连续多少次触发阈值则报警
88 "pendingCount": 1,
89
90 // 重复报警间隔，单位：分钟，默认值：0，表示关闭重复报警
91 "repeatIntervalMinute": 5,
92
93 // 恢复后是否通知 true：通知， false：不通知， 默认
94 "recoverAlarmNotice": true,
95
96 // 报警通知模板列表
97 "notices": [
98 {
99 // bcm报警模板id
100 "id": "testNotice"
101 }
102 ],
103
104 // 报警内容是否增加日志原文 false:不增加，默认 true：增加
105 "noticeWithRawLog" : true,
106
107 // 报警通知内容配置
108 "noticeRawConfigs" : [
109 {
110 // 配置类型，必填
111 // REF 自动关联执行语句
112 // CUSTOM 自定义检索语句
113 "type" : "CUSTOM",
114
115 // 若type为REF，表示执行语句序号
116 "refTarget" : 1,
117
118 // 若type为AUTO_ASSOCIATED，表示自定义检索语句
119 "query" : "match *",
120
121 // 如果每个执行语句单独选择日志集，且配置为自定义检索语句，这里表示日志集
122 "object" : {
123 // 日志集项目，必填
124 "project" : "default",
125 // 日志集名，必填
126 "logStoreName" : "bls-ng-log"
127 },
128 // 显示字段，必填写
129 // All - 所有字段
130 // SpecifiedFields - 指定字段
131 "displayType" : "ALL",
132
133 // 指定字段名列表，选填
134 "display_fields" : ["requestid", "status"],
135 // 表示展示的日志条数，最大值为5
136 "limit" : 4,
137 }
138 ]
139 }
140}