查詢告警歷史信息
更新時間 2023-08-29 15:13:55
最近更新時間: 2023-08-29 15:13:55
分享文章
接口功能介紹
調用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 | 表示請求失敗 |
錯誤碼
無
