报警策略列表
更新时间：2026-06-26
报警策略列表
查询报警策略列表，支持按策略名称、策略ID、状态、级别、指标类别等条件筛选，支持分页和排序。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/apm?action=DescribeAlarmPolicies HTTP/1.1
2Host: apm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "policyName": "",
7 "policyId": "",
8 "state": "",
9 "level": "",
10 "metricKind": "JVM",
11 "orderBy": "updatedTime",
12 "order": "desc",
13 "pageNo": 1,
14 "pageSize": 10
15}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v1 |
| policyName | String | 否 | RequestBody参数 | 按策略名称筛选 |
| policyId | String | 否 | RequestBody参数 | 按策略ID筛选 |
| state | String | 否 | RequestBody参数 | 策略状态筛选，可选值：ENABLED-启动，DISABLED-禁用 |
| level | String | 否 | RequestBody参数 | 策略级别筛选，可选值：NOTICE-通知，WARNING-警告，MAJOR-重要，CRITICAL-严重 |
| metricKind | String | 否 | RequestBody参数 | 指标类别筛选，可选值：SERVER-服务端性能指标，CLIENT-客户端性能指标，DB-数据库指标，PRODUCER-生产者，CONSUMER-消费者，INTERNAL_FUNCTION-内部函数，JVM-JVM监控，EXCEPTION-异常监控 |
| orderBy | String | 否 | RequestBody参数 | 排序字段，默认值：updatedTime，可选值：updatedTime-更新时间，createdTime-创建时间 |
| order | String | 否 | RequestBody参数 | 排序方式，默认值：desc，可选值：desc-降序，asc-升序 |
| pageNo | Integer | 是 | RequestBody参数 | 第几页，从1开始计数 |
| pageSize | Integer | 是 | RequestBody参数 | 每页展示数量，最大值：100 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 错误信息 |
| policies | List<AlarmPolicyDetail> | 策略列表 |
| pageNo | Integer | 第几页 |
| pageSize | Integer | 每页展示数量 |
| totalCount | Integer | 总数 |
请求示例
Plain Text
1POST /v1/apm?action=DescribeAlarmPolicies HTTP/1.1
2HOST apm.bj.baidubce.com
3Authorization bce-auth-v1/...
4
5{
6 "policyName": "",
7 "policyId": "",
8 "state": "",
9 "level": "",
10 "metricKind": "JVM",
11 "orderBy": "updatedTime",
12 "order": "desc",
13 "pageNo": 1,
14 "pageSize": 10
15}响应示例
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 "policies": [
13 {
14 "id": "p-ddb54dc9e3",
15 "name": "my_policy_name",
16 "content": "请求数1分钟内和值>10次",
17 "state": "ENABLED",
18 "createdTimestamp": "2025-04-20T10:01:12Z",
19 "updatedTimestamp": "2025-04-21T10:01:12Z",
20 "target": {
21 "type": "SERVICES",
22 "services": ["my_service_0", "my_service_1"]
23 },
24 "metricKind": "JVM",
25 "rule": {
26 "operator": "OR",
27 "rules": []
28 },
29 "ruleContent": "QPS>100 或 错误率>1%，连续发生1次",
30 "filters": [],
31 "pendingCount": 1,
32 "renotifyIntervalInMinutes": 5,
33 "renotifyCount": 1,
34 "notifyRecovery": true,
35 "onMissingData": "SHOW_NO_DATA_AND_NOTIFY",
36 "noDataNotifyPendingIntervalInMinutes": 5,
37 "level": "NOTICE",
38 "actions": [
39 {
40 "notifyId": "fc0fe9f1-1ed0-4012-987f-61d4b3d5125d",
41 "alias": "xxx",
42 "callBacks": ["http://apiin.im.baidu.com/api/msg?"],
43 "disableTimes": [{"from": "00:00:00", "to": "00:00:00"}],
44 "members": ["xxx"],
45 "types": ["EMAIL"]
46 }
47 ]
48 }
49 ],
50 "pageNo": 1,
51 "pageSize": 10,
52 "totalCount": 100
53}评价此篇文章