更新报警策略
更新时间:2026-06-26
更新报警策略
更新指定报警策略的配置信息,包括报警目标、报警规则、维度过滤条件、通知模板等。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/apm?action=UpdateAlarmPolicy HTTP/1.1
2Host: apm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "id": "a-ddb54dc9e3",
7 "name": "my_policy_name",
8 "target": {
9 "type": "ALL_SERVICES",
10 "tags": [
11 {"key": "some_key", "value": "some_value"}
12 ],
13 "services": ["my_service_0", "my_service_1"]
14 },
15 "metricKind": "JVM",
16 "rule": {
17 "operator": "or",
18 "rules": [
19 {
20 "operator": "and",
21 "rules": [
22 {
23 "metric": "apm_requests_count",
24 "windowInSeconds": 60,
25 "aggregate": "avg",
26 "operator": "gte",
27 "value": 100
28 },
29 {
30 "metric": "apm_err_requests_count",
31 "windowInSeconds": 60,
32 "aggregate": "avg",
33 "operator": "GTE",
34 "value": 20
35 }
36 ]
37 }
38 ]
39 },
40 "filters": [
41 {
42 "key": "service",
43 "operator": "eq",
44 "values": ["*"]
45 }
46 ],
47 "pendingCount": 1,
48 "renotifyIntervalInMinutes": 5,
49 "renotifyCount": 1,
50 "notifyRecovery": true,
51 "onMissingData": "SHOW_NO_DATA_AND_NOTIFY",
52 "noDataNotifyPendingIntervalInMinutes": 5,
53 "level": "NOTICE",
54 "actions": [
55 {
56 "notifyId": "0262f103-5dc2-4daa-8df8-078d0f2d80c5"
57 }
58 ]
59}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为v1 |
| id | String | 是 | RequestBody参数 | 策略ID |
| name | String | 是 | RequestBody参数 | 报警策略名称 |
| target | AlarmTarget | 是 | RequestBody参数 | 报警目标 |
| metricKind | String | 是 | RequestBody参数 | 指标类别,可选值:SERVER-服务端性能指标,CLIENT-客户端性能指标,DB-数据库指标,PRODUCER-生产者,CONSUMER-消费者,INTERNAL_FUNCTION-内部函数,JVM-JVM监控,EXCEPTION-异常监控 |
| rule | AlarmRule | 是 | RequestBody参数 | 报警规则,递归结构 |
| filters | List<AlarmFilter> | 否 | RequestBody参数 | 维度过滤条件列表 |
| pendingCount | Integer | 是 | RequestBody参数 | 连续触发阈值,连续多少次触发阈值则报警 |
| renotifyIntervalInMinutes | Integer | 是 | RequestBody参数 | 重复报警间隔,单位:分钟,设置为0表示关闭重复报警 |
| renotifyCount | Integer | 是 | RequestBody参数 | 最大重复次数,设置为0表示关闭重复报警 |
| notifyRecovery | Boolean | 是 | RequestBody参数 | 恢复后是否通知 |
| onMissingData | String | 是 | RequestBody参数 | 无数据处理方式,可选值:SHOW_NO_DATA_AND_NOTIFY-显示无数据且发送报警通知,SHOW_NO_DATA-显示无数据但不发送报警通知,SHOW_OK-报警恢复,EVALUATE_AS_ZERO-将无数据指标视作0与规则阈值进行比较 |
| noDataNotifyPendingIntervalInMinutes | Integer | 是 | RequestBody参数 | 无数据报警等待间隔,单位:分钟,当onMissingData为SHOW_NO_DATA_AND_NOTIFY时必填,设置为0则立即发出无数据报警 |
| level | String | 否 | RequestBody参数 | 报警级别,默认CRITICAL,可选值:NOTICE-通知,WARNING-警告,MAJOR-重要,CRITICAL-严重 |
| actions | List<AlarmAction> | 是 | RequestBody参数 | 通知模板列表,统一用于异常通知、恢复通知、重复报警通知 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 错误信息 |
请求示例
Plain Text
1POST /v1/apm?action=UpdateAlarmPolicy HTTP/1.1
2HOST apm.bj.baidubce.com
3Authorization bce-auth-v1/...
4
5{
6 "id": "a-ddb54dc9e3",
7 "name": "my_policy_name",
8 "target": {
9 "type": "ALL_SERVICES",
10 "tags": [
11 {"key": "some_key", "value": "some_value"}
12 ],
13 "services": ["my_service_0", "my_service_1"]
14 },
15 "metricKind": "JVM",
16 "rule": {
17 "operator": "or",
18 "rules": [
19 {
20 "operator": "and",
21 "rules": [
22 {
23 "metric": "apm_requests_count",
24 "windowInSeconds": 60,
25 "aggregate": "avg",
26 "operator": "gte",
27 "value": 100
28 },
29 {
30 "metric": "apm_err_requests_count",
31 "windowInSeconds": 60,
32 "aggregate": "avg",
33 "operator": "GTE",
34 "value": 20
35 }
36 ]
37 }
38 ]
39 },
40 "filters": [
41 {
42 "key": "service",
43 "operator": "eq",
44 "values": ["*"]
45 }
46 ],
47 "pendingCount": 1,
48 "renotifyIntervalInMinutes": 5,
49 "renotifyCount": 1,
50 "notifyRecovery": true,
51 "onMissingData": "SHOW_NO_DATA_AND_NOTIFY",
52 "noDataNotifyPendingIntervalInMinutes": 5,
53 "level": "NOTICE",
54 "actions": [
55 {
56 "notifyId": "0262f103-5dc2-4daa-8df8-078d0f2d80c5"
57 }
58 ]
59}
响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: request-id-example
3Date: Wed, 08 Jan 2025 03:25:48 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "code": "OK",
11 "message": ""
12}
评价此篇文章
