通知記錄：查詢
更新時間 2024-09-25 16:21:00
最近更新時間: 2024-09-25 16:21:00
分享文章
通知記錄
通知記錄：查詢
接口功能介紹
查詢通知記錄列表。
接口約束
無。
URI
GET /v4/monitor/query-message-records
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| receiver | 否 | String | 通知對象 | abc@qq.com | |
| recordType | 否 | Integer | 本參數表示通知類型。取值范圍：0：監控告警通知。1：外部告警通知。 | 0 | |
| method | 否 | String | 本參數表示通知方式。取值范圍：email：郵件。sms：短信。webhook | ||
| recordStatus | 否 | Integer | 本參數表示通知狀態。取值范圍：0：通知發送成功。1：通知發送失敗。 | 0 | |
| startTime | 否 | Integer | 創建通知起始時間，精確到毫秒 | 1690428579920 | |
| endTime | 否 | Integer | 創建通知截止時間，精確到毫秒（截止時間與起始時間間隔不超過30天） | 1690855839000 | |
| pageNo | 否 | Integer | 頁碼，默認為1 | 1 | |
| pageSize | 否 | Integer | 每頁大小，默認為20 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| MessageRecords | Array of Objects | 通知記錄列表 | MessageRecord | |
| totalCount | Integer | 總記錄數 | 20 | |
| currentCount | Integer | 當前頁記錄數 | 5 | |
| totalPage | Integer | 總頁數 | 3 |
表 MessageRecord
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| recordID | String | 通知記錄ID | 46d7bc83-7ac4-5238-a934-2076d0b9f9f0 | |
| receiver | String | 通知對象 | 123@qq.com | |
| recordType | Integer | 本參數表示通知類型。取值范圍：0：監控告警通知。1：外部告警通知。 | 0 | |
| method | String | 本參數表示通知方式。取值范圍：email：郵件。sms：短信。webhook | ||
| recordStatus | Integer | 本參數表示通知狀態。取值范圍：0：通知發送成功。1：通知發送失敗。 | 0 | |
| subject | String | 通知主題 | test | |
| content | String | 通知內容 | xxxxxxxx | |
| errMessage | String | 通知發送錯誤信息 | webhook請求錯誤 | |
| createTime | Integer | 創建時間，時間戳，精確到毫秒 | 1667459789000 |
請求示例
請求url
/v4/monitor/query-message-records
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"MessageRecords": [
{
"recordID": "653226259d6c887fdafa8c61",
"receiver": "test@chinatelecom.cn",
"recordType": 0,
"method": "email",
"recordStatus": 0,
"subject": "【一鍵報警】cpu使用率-告警通知-規則ID（6520c2528d4ae066080a34f0）",
"content": "[完成處理]尊敬的天翼云用戶，云監控告警提醒：告警狀態已恢復\"正常\"\n告警名稱：【一鍵報警】cpu使用率\n監控指標：cpu_util 【CPU使用率】\n告警描述：無描述\n資源池名稱：內蒙az\n監控對象：【監控對象：ALL】\n首次觸發時間：2023-10-08 10:12:00\n\nsystem 完成處理\n問題 5 分鐘無更新，系統自動關閉\n",
"errMessage": "",
"createTime": 1697785381111
}
],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
