API Introduction
Call describeAlarmList to query the alarm list information.
API Restrictions
None
URI
GET /v1/alarmOpenApi/describeAlarmList
Path Parameter
None
Query Parameter
None
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 alarm list information is queried successfully | |
returnObj | Yes | Object[] | Return object array | returnObj |
Table returnObj
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 | ||
createTime | Yes | Date | Alarm creation or update time | 1663817213000 |
Sample Request
Request Header
None
Request parameter query
/v1/alarmOpenApi/describeAlarmList
Response Example
{
"statusCode": 800,
"message": "the alarm list information is queried successfully",
"returnObj": [
{
"level": "critical",
"sendMail": 1,
"objName": "172.31.206.74:8030",
"message": "connect mongodb failed",
"userId": 1012,
"sendMailToList": "",
"alarmItem": "connect",
"sendSmsToList": "",
"sendSms": 1,
"alarmValue": "down",
"createTime": 1663817213000,
"objId": "d_2",
"id": 1,
"objType": "mongodb",
"sendOther": 1,
"sendOtherToList": ""
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None