API Introduction
Call describeAlarmHistoryList to query alarm history information.
API Restrictions
None
URI
GET /v1/alarmOpenApi/describeAlarmHistoryList
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
pageNow | No | Integer | Current page | If left blank, default to 1 | |
pageSize | No | Integer | Number of current pages | If left blank, default to 10 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The host alarm rules of the MongoDB instance are queried successfully | |
returnObj | Yes | Object | Return object array | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
lastPage | Yes | Integer | Last page | 8 | |
navigatepageNums | Yes | Integer[] | Number of navigation pages | ||
startRow | Yes | Object | The line number of the first element of the current page in the database | returnObj | |
hasNextPage | Yes | Boolean | Whether there is a next page | ||
prePage | Yes | Integer | Previous page | ||
nextPage | Yes | Integer | Next Page | ||
endRow | Yes | Integer | The line number of the last element of the current page in the database | ||
pageSize | Yes | Integer | Number per page | ||
list | Yes | Object[] | list | ||
pageNum | Yes | Integer | Current page | ||
navigatePages | Yes | Integer | Number of navigation pages | ||
total | Yes | Long | Total number of records. | ||
pages | Yes | Integer | Total number of pages. | ||
firstPage | Yes | Integer | First page | ||
size | Yes | Integer | Number of current pages | ||
isLastPage | Yes | Boolean | Whether it is the last page | ||
hasPreviousPage | Yes | Boolean | Whether there is a previous page | ||
isFirstPage | Yes | Boolean | Whether it is the first page |
Table list
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
id | Yes | Integer | Flag value | 62 | |
userId | Yes | Long | User id | 1012 | |
objId | Yes | String | Object ID | d_2 | |
objName | Yes | String | Alarm object name | 172.31.206.74:8030 | |
objType | Yes | String | Object Type | mongodb | |
alarmItem | Yes | String | Alarm item | connect | |
alarmValue | Yes | String | Specific data or status of the alarm item | down | |
level | Yes | String | Alarm level | critical | |
message | Yes | String | Specific description of the alarm content | connect mongodb failed | |
sendMail | Yes | Byte | Whether to enable email sending | 1 | |
sendMailToList | No | String | Email recipient list | ||
sendSms | Yes | Byte | Whether to enable SMS sending | 1 | |
sendSmsToList | No | String | SMS recipient list | ||
sendOther | Yes | Byte | Whether to enable other forms of alarm | 1 | |
sendOtherToList | No | String | Recipient list of other forms of alarm | ||
sendMailStatus | Yes | Byte | Email push status | 0 | |
sendSmsStatus | Yes | Byte | SMS push status | 0 | |
sendOtherStatus | Yes | Byte | Push status of other forms of alarm | 0 | |
createTime | Yes | Date | Alarm creation or update time | 1663817213000 |
Sample Request
Request Header
None
Request parameter query
/v1/alarmOpenApi/describeAlarmHistoryList?pageNow=1&pageSize=1
Response Example
{
"statusCode": 800,
"message": "the alarm history information is queried successfully",
"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
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None