查詢告警列表信息
更新時間 2023-08-29 15:13:55
最近更新時間: 2023-08-29 15:13:55
分享文章
接口功能介紹
調用describeAlarmListt查詢告警列表信息。
接口約束
無
URI
GET /v1/alarmOpenApi/describeAlarmList
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
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 | 表示請求失敗 |
錯誤碼
無
