报警历史相关接口
更新时间：2024-09-09
报警历史相关接口
报警历史列表查询接口
接口描述
该接口可获取云产品监控、站点监控等相关报警的报警历史列表信息。
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| 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 | 报警历史历史总共个数 |
请求示例
// build client
String endpoint = "http://bcm.bj.baidubce.com";
String userId = "a0d04d7c***************7b6752ce4";
String ak = "ALTAK***************3hVCYG";
String sk = "b2c53*******************f9993ac1";
BcmClientConfiguration config = new BcmClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ak, sk));
config.setEndpoint(endpoint);
bcmClient = new BcmClient(config);
AlarmListRequest request = new AlarmListRequest();
request.setUserId(userId);
request.setAlarmType("ALARM_TYPE_CLOUD");
request.setPageNo(1);
request.setPageSize(10);
request.setRegion("bj");
request.setScope("BCE_BCC");
request.setStartTime(1722844725412L);
request.setEndTime(1723449525412L);
AlarmListResponse alarmList = bcmClient.getAlarmList(request);
// Response
{
"result": {
"alarms": [
{
"id": "9f7718dd**********82675ee",
"seriesId": "8e7e040**********994c40198097c0",
"startTime": 1723446539999,
"state": "OK",
"userId": "a0d04**********52ce4",
"endTime": 1723446599999,
"initState": "ALERT",
"policy": {
"aliasName": "qgg**********",
"content": "CPU使用率1分钟内平均值>3%，连续发生1次触发报警",
"contentEn": "the average of CPUUsagePercent within 1 minute > 3%, occurring 1 time in a row",
"name": "b905**********b343f"
},
"resource": {
"identifiers": {
"InstanceId": "i-21**********N"
},
"properties": {
"application": "bcc",
"shortInstanceId": "i-21**********N"
},
"region": "bj",
"resourceType": "Instance",
"scope": "BCE_BCC"
},
"actions": [
{
"alias": "li**********",
"callBacks": [
"http://api*******************4790b0"
],
"executedTime": 1723446605,
"members": [
"li**********"
],
"name": "li**********",
"notifications": [
"EMAIL"
],
"type": "ACTION_TYPE_ALERT"
}
]
}
],
"pageNo": 1,
"pageSize": 1,
"totalCount": 5039
},
"success": true
}报警历史详情查询接口
请求描述
可以根据报警id来获取报警的详情信息
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户ID | 是 | RequestBody参数 |
| alarmId | String | 警报id，全局唯一, 可以从报警历史列表接口获取 | 是 | RequestBody参数 |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| msg | String | 若失败，返回失败原因 |
| result | Alarm | 报警详情内容 |
请求示例
// build client
String endpoint = "http://bcm.bj.baidubce.com";
String userId = "a0d04d7c***************7b6752ce4";
String ak = "ALTAK***************3hVCYG";
String sk = "b2c53*******************f9993ac1";
BcmClientConfiguration config = new BcmClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ak, sk));
config.setEndpoint(endpoint);
bcmClient = new BcmClient(config);
AlarmDetailRequest request = new AlarmDetailRequest();
request.setAlarmId("4d38c9**********c4ede387");
request.setUserId(userId);
AlarmDetailResponse alarmDetail = bcmClient.getAlarmDetail(request);
// Response
{
"success": true,
"result": {
"id": "4d38c9**********c4ede387",
"seriesId": "8e7e04034**********198097c0",
"userId": "a0d04**********752ce4",
"initState": "ALERT",
"state": "OK",
"closeReason": null,
"startTime": 1723531319999,
"endTime": 1723531379999,
"resource": {
"scope": "BCE_BCC",
"resourceType": "Instance",
"region": "bj",
"identifiers": {
"InstanceId": "i-21**********N"
},
"properties": {
"application": "bcc",
"shortInstanceId": "i-21**********N"
}
},
"policy": {
"name": "b905**********b343f",
"aliasName": "q**********",
"content": "CPU使用率1分钟内平均值>3%，连续发生1次触发报警",
"contentEn": "the average of CPUUsagePercent within 1 minute > 3%, occurring 1 time in a row"
},
"actions": [
{
"type": "ACTION_TYPE_ALERT",
"name": "li**********",
"executedTime": 1723531384,
"alias": "li**********",
"notifications": [
"EMAIL",
"SMS"
],
"callBacks": [
"http://api*******************4790b0"
],
"members": [
"li**********"
]
}
],
"alertMetrics": [
{
"metric": {
"name": "CPUUsagePercent",
"value": 3,
"aliasName": "CPU使用率1分钟内平均值",
"aliasNameEn": "1 min average of CPUUsagePercent",
"unit": "%"
},
"rule": {
"seq": 0,
"operator": "OPERATOR_TYPE_GT",
"threshold": 3
}
}
]
}
}附录
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 | 报警阈值 |
