报警事件列表
更新时间:2026-06-26
报警事件列表
查询报警事件列表,支持按时间范围、策略名称、报警等级、指标类型、报警状态等条件筛选,支持分页和排序。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/apm/alarm?action=DescribeAlarms HTTP/1.1
2Host: apm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "beginDatetime": "20241011T10:10:10Z",
7 "endDatetime": "20241011T10:25:10Z",
8 "policyName": "",
9 "level": "NOTICE",
10 "metricKind": "",
11 "state": "ALERT",
12 "orderBy": "startTime",
13 "order": "desc",
14 "pageNo": 1,
15 "pageSize": 10
16}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为v1 |
| beginDatetime | String | 是 | RequestBody参数 | 开始时间,UTC时间 |
| endDatetime | String | 是 | RequestBody参数 | 结束时间,UTC时间 |
| policyName | String | 否 | RequestBody参数 | 按策略名称过滤 |
| level | String | 否 | RequestBody参数 | 报警等级过滤,可选值:NOTICE-通知,WARNING-警告,MAJOR-重要,CRITICAL-严重 |
| metricKind | String | 否 | RequestBody参数 | 指标类型过滤,可选值:SERVER-服务端性能指标,CLIENT-客户端性能指标,DB-数据库指标,PRODUCER_CONSUMER-生产者消费者,INTERNAL_FUNCTION-内部函数,JVM-JVM监控,EXCEPTION-异常监控 |
| state | String | 否 | RequestBody参数 | 报警状态过滤,可选值:OK-已恢复,ALERT-报警中,NODATA-无数据报警,CLOSED-已关闭 |
| orderBy | String | 否 | RequestBody参数 | 排序字段,默认值:startTime,可选值:startTime-报警开始时间 |
| order | String | 否 | RequestBody参数 | 排序方式,默认值:desc,可选值:desc-降序,asc-升序 |
| pageNo | Integer | 是 | RequestBody参数 | 第几页,从1开始计数 |
| pageSize | Integer | 是 | RequestBody参数 | 每页展示数量,最大值:100 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 错误信息 |
| alarms | List<AlarmEventDetail> | 报警事件列表 |
| pageNo | Integer | 第几页 |
| pageSize | Integer | 每页展示数量 |
| totalCount | Integer | 总数 |
请求示例
Plain Text
1POST /v1/apm/alarm?action=DescribeAlarms HTTP/1.1
2HOST apm.bj.baidubce.com
3Authorization bce-auth-v1/...
4
5{
6 "beginDatetime": "20241011T10:10:10Z",
7 "endDatetime": "20241011T10:25:10Z",
8 "policyName": "",
9 "level": "NOTICE",
10 "metricKind": "",
11 "state": "ALERT",
12 "orderBy": "startTime",
13 "order": "desc",
14 "pageNo": 1,
15 "pageSize": 10
16}
响应示例
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 "alarms": [
13 {
14 "id": "a-8aab556f3f7b",
15 "startTime": "2024-04-10T10:12:30Z",
16 "endTime": "2024-04-10T11:21:31Z",
17 "duration": 17,
18 "initState": "ALERT",
19 "state": "ALERT",
20 "closeReason": "POLICY_MODIFIED",
21 "currentValue": "请求次数(总和)=15次",
22 "monitorObject": "demo-djw(实例:gzbh-sandbox01-7502.gzbh.baidu.com)",
23 "policy": {
24 "id": "p-ddb54dc9e3",
25 "name": "my_policy_name",
26 "createdTimestamp": "2025-04-20T10:01:12Z",
27 "updatedTimestamp": "2025-04-21T10:01:12Z",
28 "content": "请求数1分钟内和值>10次",
29 "state": "ENABLED",
30 "target": {
31 "type": "SERVICES",
32 "services": ["my_service_0", "my_service_1"]
33 },
34 "metricKind": "JVM",
35 "rule": {
36 "operator": "OR",
37 "rules": []
38 },
39 "region": "bj",
40 "filters": [],
41 "pendingCount": 1,
42 "renotifyIntervalInMinutes": 5,
43 "renotifyCount": 1,
44 "notifyRecovery": true,
45 "onMissingData": "SHOW_NO_DATA_AND_NOTIFY",
46 "noDataNotifyPendingIntervalInMinutes": 5,
47 "level": "NOTICE",
48 "actions": []
49 }
50 }
51 ],
52 "pageNo": 1,
53 "pageSize": 10,
54 "totalCount": 100
55}
评价此篇文章
