报警历史
更新时间：2025-08-20
报警历史列表
请求结构
- method：POST
- URL：/ah-api/v1/alarmhouse/alarm/list
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | RequestBody参数 |
| alarmType | String | 警报类型，必填，可选值: ALARM_TYPE_CLOUD (云产品监控) ALARM_TYPE_SITE (站点监控) ALARM_TYPE_CUSTOM (自定义监控) ALARM_TYPE_APP (应用监控) |
是 | RequestBody参数 |
| pageNo | Int | 第几页，从1开始计数，必填 | 是 | RequestBody参数 |
| pageSize | Int | 每页展示数量，必填，最大值：100 | 是 | RequestBody参数 |
| startTime | Int | 起始时间，Unix时间戳，单位：毫秒，选填，若未设置，默认为40天前 | 否 | RequestBody参数 |
| endTime | Int | 结束时间，Unix时间戳，单位：毫秒，选填，若未设置，默认为当前时间 | 否 | RequestBody参数 |
| scope | String | 云产品，选填，若未设置，表示返回所有云产品的警报 | 否 | RequestBody参数 |
| resourceType | String | 监控对象类型，选填，若未设置，表示返回所有监控对象类型的警报 | 否 | RequestBody参数 |
| states | List<String> | 警报状态，选填，可同时筛选多个状态，若未设置，表示返回所有状态的警报，可选值: OK (恢复正常) ALERT (异常中) INSUFFICIENT_DATA (数据不足) CLOSED (已关闭) |
否 | RequestBody参数 |
| sort | String | 排序字段, 选填，若未设置，默认为startTime，可选项： startTime |
否 | RequestBody参数 |
| ascending | Boolean | 是否升序，选填，默认false | 否 | RequestBody参数 |
| level | String | 报警等级，选填，若未设置，表示返回所有等级的警报，可选值： ALARM_LEVEL_NOTICE (通知) ALARM_LEVEL_WARNING (警报) ALARM_LEVEL_MAJOR (重要) ALARM_LEVEL_CRITICAL (严重) |
否 | RequestBody参数 |
| region | String | 地域，选填，若未设置，表示返回所有地域的警报 | 否 | RequestBody参数 |
| alarmAliasName | String | 按策略名模糊查询，选填 | 否 | RequestBody参数 |
| resource | ResourceKV | 按实例进行搜索，选填 | 否 | RequestBody参数 |
| resources | List<ResourceKV> | 按多个实例进行搜索，选填 | 否 | RequestBody参数 |
ResourceKV
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| InstanceId | String | 实例id，选填 | 否 | RequestBody参数 |
| taskId | String | 站点监控任务id，填写taskId指定站点监控任务 | 否 | RequestBody参数 |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| msg | String | 若失败，返回失败原因 |
| result | PageResult | 按页封装结果 |
PageResult
| 名称 | 类型 | 描述 |
|---|---|---|
| alarms | List<Alarm> | 报警历史列表 |
| pageNo | Int | 页码编号 |
| pageSize | Int | 页面大小 |
| totalCount | Int | 报警历史历史总共个数 |
请求示例
JSON
1POST /ah-api/v1/alarmhouse/alarm/list
2{
3 "userId": "453bf9********************9090dc",
4 "startTime": 1722319915374,
5 "endTime": 1722924715374,
6 "alarmType": "ALARM_TYPE_CLOUD",
7 "scope": "BCE_BCC",
8 "resourceType": "Instance",
9 "states": ["OK"],
10 "sort": "startTime",
11 "ascending": false,
12 "level": "ALARM_LEVEL_NOTICE",
13 "region": "bj",
14 "alarmAliasName": "测试策略",
15 "resource": {
16 "InstanceId": "i-12*****7",
17 "taskId": "yotKl***************MBsNgSmBZ",
18 },
19 "resources": [
20 {"InstanceId": "i-12*****7"},
21 {"InstanceId": "i-83*****e"},
22 ],
23 "pageNo": 1,
24 "pageSize": 10,
25}
26
27
28// Response
29{
30 "success": true,
31 "msg": "",
32 "result": {
33 "alarms": [
34 {
35 "id": "f54c9563fe32**********680d381f9f68931",
36 "userId": "453bf9********************9090dc",
37 "seriesId": "ab910517974c*********79e79f46200f25cb",
38 "startTime": 1722924659999,
39 "endTime": 1722924719999,
40 "state": "ALERT",
41 "closeReason": "INSUFFICIENT_DATA",
42 "policy": {
43 "name": "919ad2628dad**********85f4132ad9e",
44 "aliasName": "eip-all-test",
45 "updateTime": 1722425024000,
46 "content": "从外网进入的流量1分钟平均值 > 100Bytes，连续发生1次",
47 "contentEn": "The average internet input traffic > 100Bytes, ocurring once in a row",
48 "level": "ALARM_LEVEL_MAJOR",
49 "checkPeriod": 60
50 }
51 "resource": {
52 "scope": "BCE_BCC",
53 "resourceType": "Instance",
54 "region": "bj",
55 "identifiers": {
56 "InstanceId": "ip-12*****7",
57 },
58 "properties": {
59 "application": "bcc",
60 "internalIp": "192.168.16.10",
61 "shortInstanceId": "i-I8*****J"
62 }
63 }
64 "actions": [
65 {
66 "type": "ACTION_TYPE_OK",
67 "name": "test_action",
68 "executedTime": 1722924721，
69 "alias": "默认动作"
70 "notifications": [
71 "EMAIL",
72 "SMS",
73 "PHONE"
74 ],
75 "callBacks": [
76 "http://apiin.im.baidu.com/api/msg/xxxxx"
77 ],
78 "members": [
79 "zsli",
80 "test_user"
81 ]
82 }
83 ]
84 }
85 ]
86 "pageNo": 1,
87 "pageSize": 10,
88 "totalCount": 12345,
89 }
90}报警历史详情
请求结构
- method：GET
- URL：/ah-api/v1/alarmhouse/alarm?alarmId=${alarmId}&userId=${userId}
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户ID | 是 | Path参数 |
| alarmId | String | 警报id，全局唯一, 可以从报警历史列表接口获取 | 是 | Path参数 |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| msg | String | 若失败，返回失败原因 |
| result | Alarm | 报警详情内容 |
请求示例
JSON
1GET ah-api/v1/alarmhouse/alarm?
2alarmId=f54c9563fe32**********680d381f9f68931&
3userId=453bf9********************9090dc
4
5// Response
6{
7 "success": true,
8 "msg": "",
9 "result": {
10 "id": "f54c9563fe32**********680d381f9f68931",
11 "userId": "453bf9********************9090dc",
12 "seriesId": "ab910517974c*********79e79f46200f25cb",
13 "startTime": 1659534994121,
14 "endTime": 0,
15 "initState": "ALERT",
16 "state": "ALERT",
17 "closeReason": "INSUFFICIENT_DATA",
18 "policy": {
19 "name": "919ad2628dad42f78280c85f4132ad9e",
20 "aliasName": "eip-all-test",
21 "updateTime": 1722425024000,
22 "content": "从外网进入的流量1分钟平均值 > 100Bytes，连续发生1次",
23 "contentEn": "The average internet input traffic > 100Bytes, ocurring once in a row",
24 "level": "ALARM_LEVEL_MAJOR",
25 "checkPeriod": 60,
26 },
27 "resource": {
28 "scope": "BCE_BCC",
29 "resourceType": "Instance",
30 "region": "bj",
31 "identifiers": {
32 "instanceId": "ip-12*****7",
33 }
34 },
35 "actions": [
36 {
37 "type": "ACTION_TYPE_OK",
38 "name": "test_action",
39 "executedTime": 1659534994121,
40 "notifications" : [
41 "EMAIL",
42 "SMS",
43 "PHONE"
44 ],
45 "callBacks" : [
46 "http://apiin.im.baidu.com/api/msg/xxxxx"
47 ],
48 "members" : [
49 "zxj",
50 "test_user"
51 ]
52 }
53 ],
54 "alertMetrics": [
55 {
56 "metric": {
57 "name": "CpuUsage",
58 "value": 50,
59 "dimensions": {
60 "dimension_key": "dimension_value"
61 },
62 "aliasName": "CPU使用率1分钟平均值",
63 "aliasNameEn": "1 min average of cpu usage",
64 "unit": "%",
65 },
66 "rule": {
67 "seq": 0,
68 "operator": "OPERATOR_TYPE_LE",
69 "threshold": 10,
70 "statistics": "STATISTICS_TYPE_AVG",
71 "window": 60
72 }
73 }
74 ]
75 }
76}附录
Alarm
| 名称 | 类型 | 描述 |
|---|---|---|
| id | String | 警报id，全局唯一 |
| seriesId | String | 用户id |
| userId | String | 警报序列id |
| initState | String | 初始警报状态，可能值： OK (恢复正常) ALERT (异常中) INSUFFICIENT_DATA (数据不足) CLOSED (已关闭) |
| state | String | 当前状态，一个警报最多有两个状态，若当前状态=初始状态，表示警报仍停留在初始状态 |
| closeReason | String | 若警报已关闭，该字段填写关闭原因，可能值： INSUFFICIENT_DATA (无数据) POLICY_MODIFIED (策略更改或删除) |
| startTime | Int | 警报开始时间，Unix时间戳，单位：毫秒 |
| endTime | Int | 警报结束时间，Unix时间戳，单位：毫秒，若警报未结束，该字段填0 |
| resource | Resource | 警报关联的资源 |
| policy | Policy | 报警对应的报警策略 |
| actions | List<Action> | 报警动作列表 |
| alertMetrics | List<AlertMetrics> | 触发报警的指标信息，查询历史详情时会返回 |
Resource
| 名称 | 类型 | 描述 |
|---|---|---|
| scope | String | 所属云产品 |
| resourceType | String | 云产品子资源类型 |
| region | String | 地域 |
| identifiers | Map<String, String> | 资源标识，不同云产品有不同的标识符 |
| properties | Map<String, String> | 资源属性，不同云产品有不同的资源属性 |
Policy
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 策略名，用于查询策略详情 |
| aliasName | String | 策略显示名 |
| content | String | 策略内容 |
| contentEn | String | 英文策略内容 |
| extra | Map<String, String> | 报警策略的一些额外属性，如果存在会返回 |
Action
| 名称 | 类型 | 描述 |
|---|---|---|
| type | String | 动作类型，可选值： ACTION_TYPE_OK (恢复通知) ACTION_TYPE_ALERT (异常通知) ACTION_TYPE_INSUFFICIENT_DATA (数据不足通知) ACTION_TYPE_CALLBACK (报警回调) |
| name | String | 动作名称，当type=ACTION_TYPE_CALLBACK，该字段填写回调地址 |
| executedTime | Int | 动作执行时间，Unix时间戳，单位：毫秒，若该字段为0或未设置，表示动作未执行 |
| alias | String | 通知模板名称 |
| notifications | List<String> | 通知的方式，仅包括三种：邮件、短信、电话 |
| callBacks | List<String> | 报警回调链接 |
| members | List<String> | 用户/用户组信息 |
AlertMetrics
| 名称 | 类型 | 描述 |
|---|---|---|
| metric | Metric | 触发报警的指标信息 |
| rule | Rule | 触发指标报警的规则 |
Metric
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 指标名称 |
| value | Int | 报警触发时的指标值 |
| dimensions | Map<String,String> | 指标维度 |
| aliasName | String | 指标中文名 |
| aliasNameEn | String | 指标英文名 |
| unit | String | 指标单位 |
Rule
| 名称 | 类型 | 描述 |
|---|---|---|
| seq | Int | 规则报警策略中的序列，seq相同，表示是同一个规则 |
| operator | String | 比较方式，可能值： OPER_TYPE_GT(大于) OPER_TYPE_GE(大于等于) OPER_TYPE_LT(小于) OPER_TYPE_LE(小于等于) OPER_TYPE_EQ(等于) OPER_TYPE_NE(不等于) 环比上升: OPER_TYPE_INC_RATE_GT(环比上周期增长大于) OPER_TYPE_INC_RATE_GE(环比上周期增长大于等于) OPER_TYPE_INC_RATE_LT(环比上周期增长小于) OPER_TYPE_INC_RATE_LE(环比上周期增长小于等于) OPER_TYPE_INC_RATE_EQ(环比上周期增长等于) OPER_TYPE_INC_RATE_NE(环比上周期增长不等于) 环比下降: OPER_TYPE_DEC_RATE_GT(环比上周期下降大于) OPER_TYPE_DEC_RATE_GE(环比上周期下降大于等于) OPER_TYPE_DEC_RATE_LT(环比上周期下降小于) OPER_TYPE_DEC_RATE_LE(环比上周期下降小于等于) OPER_TYPE_DEC_RATE_EQ(环比上周期下降等于) OPER_TYPE_DEC_RATE_NE(环比上周期下降不等于) |
| threshold | Int | 报警阈值 |