获取警报列表
开发中GET
/api/alerts此接口需要被轮询,因为警报可能随时被创建或删除。
需要特别注意,根据 unread 参数的不同,可能返回不分页/分页的响应结构。
请求参数
Query 参数
page
integer
可选
示例值:
1
pageSize
integer
可选
示例值:
10
unread
boolean
可选
只获取未读的警报(添加此参数后,获取的警报列表不分页)
示例值:
true
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
success
boolean
必需
message
null
必需
data
object
必需
page
integer
必需
size
integer
必需
total
integer
必需
results
$ref(#/definitions/116832607)[]
必需
示例
unread=false
{
"success": true,
"message": null,
"data": {
"page": 1,
"size": 10,
"total": 1,
"results": [
{
"id": 1,
"createAt": 1729671865926,
"readAt": null,
"level": "INFO",
"identifier": "unstable-alert",
"title": "您当前正在使用的是 PeerBanHelper 的非稳定版本",
"content": "非稳定版本的构建仅用于测试,且可能存在严重缺陷。在继续使用非稳定版本前,请做好数据备份。如遇到错误,请前往 [Issue Tracker](https://github.com/PBH-BTN/PeerBanHelper/issues) 反馈。"
}
]
}
}
最后修改时间: 1 个月前