通知记录
通知记录：查询
接口功能介绍
查询通知记录列表。
接口约束
无。
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 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
