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