接口功能介绍
调用describeAlarmListt查询告警列表信息。
接口约束
无
URI
GET /v1/alarmOpenApi/describeAlarmList
路径参数
无
Query参数
无
请求参数
请求头header参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
statusCode | 是 | Integer | 响应码 | 800 | |
message | 是 | String | 响应信息 | 查询告警列表信息成功 | |
returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
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 | 其他形式的告警的接收人列表 | ||
createTime | 是 | Date | 告警的创建或更新时间 | 1663817213000 |
请求示例
请求头header
无
请求参数query
/v1/alarmOpenApi/describeAlarmList
响应示例
{
"statusCode": 800,
"message": "查询告警列表信息成功",
"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": ""
}
]
}状态码
状态码 | 描述 |
800 | 表示请求成功 |
900 | 表示请求失败 |
错误码
无