接口功能介绍
调用接口查询RDS通知列表。
接口约束
无
URI
GET /v1/open-api/other/query-notify
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
withConfirmed | 否 | Boolean | 是否包含已确认通知,默认为true | testprodInst | |
from | 是 | String | 查询通知起始时间,格式为"yyyy-MM-ddCHH:mm:ss",其中C代表中国标准时间 | 2022-11-20C13:12:12 | |
to | 是 | String | 查询通知截止时间,格式为"yyyy-MM-ddCHH:mm:ss",其中C代表中国标准时间 | 2022-11-21C13:12:12 | |
pageNow | 否 | Integer | 当前页码,默认为1 | 1 | |
pageSize | 否 | Integer | 每页包含通知条数,默认为10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Array of Objects | 返回结果信息 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
startRow | 是 | Integer | 起始页 | 1 | |
navigatepageNums | 是 | Array of Integers | 可选页码范围 | ||
hasNextPage | 是 | Boolean | 是否有下一页 | false | |
prePage | 是 | Integer | 上一页 | 1 | |
nextPage | 是 | Integer | 下一页 | 1 | |
endRow | 是 | Integer | 结束行数 | 1 | |
pageSize | 是 | Integer | 每页数据行数 | 1 | |
pageNum | 是 | Integer | 页数 | ||
navigatePages | 是 | Integer | 每页显示的页码个数 | ||
navigateFirstPage | 是 | Integer | 页面显示的第一个页码 | ||
total | 是 | Integer | 总条数 | ||
pages | 是 | Integer | 总页数 | ||
size | 是 | Integer | 当前页条目数 | ||
isLastPage | 是 | Boolean | 是否是最后一页 | ||
hasPreviousPage | 是 | Boolean | 是否有上一页 | ||
navigateLastPage | 是 | Integer | 页面上显示的最后一个页码 | ||
isFirstPage | 是 | Integer | 是否是首页 | ||
list | 是 | Array of Objects | 数据集合 |
表 list
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 通知id | ||
userId | 是 | Long | 通知所属租户id | ||
type | 是 | Integer | 通知类型 | Operation | |
level | 是 | String | 通知级别 | Succes | |
title | 是 | String | 通知标题 | ||
content | 是 | String | 通知内容 | ||
confirmFlag | 是 | Boolean | 通知是否被确认 | ||
confirmor | 是 | Long | 通知确认者id,0代表被系统确认 | ||
createTime | 是 | String | 通知创建时间,格式为"yyyy-MM-ddCHH:mm:ss",其中C代表中国标准时间 | ||
updateTime | 是 | String | 通知确认时间,格式为"yyyy-MM-ddCHH:mm:ss",其中C代表中国标准时间 |
请求示例
ip:port/baseUrl/v1/open-api/other/query-notify?from=2022-11-20C13:12:12&to=2022-11-22C13:40:15&withConfirmed=true
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [
1
],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 1,
"pageSize": 10,
"list": [
{
"confirmor": 3127,
"createTime": "2022-11-21 03:04:24",
"level": "Notice",
"updateTime": "2022-11-21 08:30:04",
"id": 1,
"confirmFlag": true,
"title": "notice",
"type": "Operation",
"userId": 3127,
"content": "hello"
}
],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 1,
"pages": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |