接口描述
查看通知消息列表
请求方法
GET
URI
/v1/notify/query
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| pageNum | query | Integer | 是 | 页码 |
| pageSize | query | Integer | 是 | 页大小 |
| startTime | query | Long | 否 | 查询开始时间，格式：时间戳 |
| endTime | query | Long | 否 | 查询结束时间，格式：时间戳 |
| withConfirmed | query | Boolean | 否 | 结果是否包含已确认的通知，true为包含，默认为true |
响应参数
| 名称 | 二级节点 | 三级节点 | 类型 | 说明 |
|---|---|---|---|---|
| message | String | 消息提示 | ||
| statusCode | Integer | 状态码 | ||
| returnObj | Object | 所有的返回信息都以JSON形式保存 | ||
| pageNum | Integer | 页码 | ||
| pageSize | Integer | 每页最大条数 | ||
| total | Integer | 总记录数 | ||
| pageTotal | Integer | 总页数 | ||
| List | Array | |||
| confirmFlag | Boolean | 通知是否确认，true为已确认 | ||
| notifyContent | String | 通知内容： 实例创建是否成功、实例已删除、实例已暂停 | ||
| notifyId | Integer | 通知唯一ID | ||
| notifyLevel | String | 通知等级： notice:普通通知 warning:提醒通知 | ||
| notifyTime | String | 创建时间 | ||
| notifyType | String | 通知类型： InstanceOperation：实例操作 | ||
| updateTime | String | 更新时间 | ||
| userId | Long | 用户ID |
示例
请求示例
/v1/notify/queryNotify?pageNum=1&pageSize=1&startTime=1662189142000&endTime=&withConfirmed=true
响应示例
{
"message": "SUCCESS",
"opMessage": "",
"returnObj": {
"list": [
{
"confirmFlag": true,
"notifyContent": "创建实例失败，工单号:19063",
"notifyId": 4,
"notifyLevel": "warning",
"notifyTime": "2022-09-03 15:13:19",
"notifyType": "InstanceOperation",
"updateTime": "2022-09-03 15:13:19",
"userId": 1
}
],
"pageNum": 1,
"pageSize": 1,
"pageTotal": 1,
"total": 1
},
"statusCode": 800
}
错误码
访问ErrorCodes说明文档查看更多错误码。
