接口功能介绍
调用describeAlarmHistoryList查询告警历史信息。
接口约束
无
URI
GET /v1/alarmOpenApi/describeAlarmHistoryList
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| pageNow | 否 | Integer | 当前页 | 不填则默认为1 | |
| pageSize | 否 | Integer | 当前页数量 | 不填则默认为10 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询MongoDB实例的主机告警规则成功 | |
| returnObj | 是 | Object | 返回对象数组 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| lastPage | 是 | Integer | 最后一页 | 8 | |
| navigatepageNums | 是 | Integer[] | 导航页码数 | ||
| startRow | 是 | Object | 当前页面第一个元素在数据库中的行号 | returnObj | |
| hasNextPage | 是 | Boolean | 是否有下一页 | ||
| prePage | 是 | Integer | 前一页 | ||
| nextPage | 是 | Integer | 下一页 | ||
| endRow | 是 | Integer | 当前页面最后一个元素在数据库中的行号 | ||
| pageSize | 是 | Integer | 每页的数量 | ||
| list | 是 | Object[] | list | ||
| pageNum | 是 | Integer | 当前页 | ||
| navigatePages | 是 | Integer | 导航页码数 | ||
| total | 是 | Long | 总记录数 | ||
| pages | 是 | Integer | 总页数 | ||
| firstPage | 是 | Integer | 第一页 | ||
| size | 是 | Integer | 当前页的数量 | ||
| isLastPage | 是 | Boolean | 是否为最后一页 | ||
| hasPreviousPage | 是 | Boolean | 是否有前一页 | ||
| isFirstPage | 是 | Boolean | 是否为第一页 |
表list
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 标志值 | 62 | |
| userId | 是 | Long | 用户id | 1012 | |
| objId | 是 | String | 对象ID | d_2 | |
| objName | 是 | String | 告警对象名称 | 172.31.206.74:8030 | |
| objType | 是 | String | 对象类型 | mongodb | |
| alarmItem | 是 | String | 告警项 | connect | |
| alarmValue | 是 | String | 告警项的具体数据或状态 | down | |
| level | 是 | String | 告警级别 | critical | |
| message | 是 | String | 告警内容的具体描述 | connect mongodb failed | |
| sendMail | 是 | Byte | 是否开启邮件发送 | 1 | |
| sendMailToList | 否 | String | 邮件接收人列表 | ||
| sendSms | 是 | Byte | 是否开启短信发送 | 1 | |
| sendSmsToList | 否 | String | 短信接收人列表 | ||
| sendOther | 是 | Byte | 是否开启其他形式的告警 | 1 | |
| sendOtherToList | 否 | String | 其他形式的告警的接收人列表 | ||
| sendMailStatus | 是 | Byte | 邮件推送状态 | 0 | |
| sendSmsStatus | 是 | Byte | 短信推送状态 | 0 | |
| sendOtherStatus | 是 | Byte | 其他形式的告警信息推送状态 | 0 | |
| createTime | 是 | Date | 告警的创建或更新时间 | 1663817213000 |
请求示例
请求头header
无
请求参数query
/v1/alarmOpenApi/describeAlarmHistoryList?pageNow=1&pageSize=1
响应示例
{
"statusCode": 800,
"message": "查询告警历史信息成功",
"returnObj": {
"lastPage": 8,
"navigatepageNums": [
1,
2,
3,
4,
5,
6,
7,
8
],
"startRow": 1,
"hasNextPage": true,
"prePage": 0,
"nextPage": 2,
"endRow": 1,
"pageSize": 1,
"list": [
{
"sendOtherStatus": 0,
"sendMailStatus": 0,
"level": "ok",
"sendMail": 1,
"objName": "172.31.205.90:8030",
"message": "connect mongodb succeeded",
"userId": 1012,
"sendMailToList": "",
"alarmItem": "connect",
"sendSmsToList": "",
"sendSms": 1,
"alarmValue": "up",
"createTime": 1666660888000,
"sendSmsStatus": 0,
"objId": "d_59",
"id": 36027,
"objType": "mongodb",
"sendOther": 1,
"sendOtherToList": ""
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 9163,
"pages": 9163,
"firstPage": 1,
"size": 1,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": true
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
