版本 2.4.8 · 最新
日志审计 audit
只读的登录日志、操作日志、节点 IP 切换日志与消息发送日志,可按用户、时间等条件过滤。
点击任一接口,右侧显示对应的调用示例。
运维与系统鉴权: 用户(部分参数仅管理员)4 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/audit/ip-switch-logs列出 IP 切换日志
鉴权: 仅管理员
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
type | string | 按来源过滤:manual、monitor、bandwidth、backup、backup_ip、backup_default 或 drain(见 IpSwitchLog.type)。 |
action | string | 按动作过滤:disable 或 enable。 |
node_id | integer | 按节点过滤。 |
node_group_id | integer | 按节点组过滤。 |
line_id | integer | 按线路过滤。 |
ip | string | 按 IP 过滤(精确匹配)。 |
since | string | 起始时间(含),RFC 3339。 |
until | string | 截止时间(不含),RFC 3339。 |
GET
/api/v2/audit/login-logs列出登录日志
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
tenant_id | integer | 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。 |
tenant_ids | string | 仅管理员可用:只看这些租户,逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用。只做过滤、不切换请求作用域,与 tenant_id 及其他条件取交集;租户凭据带了非空值回 403。 |
ip | string | 按来源 IP 子串过滤。 |
success | boolean | 只看成功(true)或失败(false)。 |
method | string | 按登录方式过滤:password 口令登录(含动态口令第二步);sso 超管代登录;admin_switch 面板管理员切换。 |
since | string | 起始时间(含),RFC 3339。 |
until | string | 结束时间(不含),RFC 3339。 |
GET
/api/v2/audit/message-send-logs列出消息发送日志
鉴权: 仅管理员
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
user_id | integer | 用户 ID |
msg_id | integer | 按消息 id 过滤。 |
user_ids | string | 只看这些用户:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);与 user_id 同给取交集。 |
msg_ids | string | 只看这些消息:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);与 msg_id 同给取交集。 |
channel | string | 按发信通道过滤(email 邮件、sms 短信、webhook 告警 Webhook)。 |
webhook_id | integer | 按 Webhook id 过滤(只有 webhook 通道的记录带它)。 |
kind | string | 按消息类型或直发类别过滤(等值),如 traffic-exceed。 |
state | string | 按发送状态过滤(done 成功、failed 失败)。 |
after_id | integer | 只看 id 大于它的记录(面板页签徽标数「看过之后的新失败」用)。 |
GET
/api/v2/audit/operation-logs列出操作日志
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
tenant_id | integer | 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。 |
tenant_ids | string | 仅管理员可用:只看这些租户,逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用。只做过滤、不切换请求作用域,与 tenant_id 及其他条件取交集;租户凭据带了非空值回 403。 |
action | string | 按动作前缀过滤,如 `user.` 或 `config.update`。 |
target_type | string | 按对象类型过滤。 |
target | string | 按对象模糊查:对象类型或对象 ID 含该串。 |
detail | string | 按变更内容模糊查:详情 JSON(变更前后的字段)含该串。 |
ip | string | 按来源 IP 子串过滤。 |
since | string | 起始时间(含),RFC 3339。 |
until | string | 结束时间(不含),RFC 3339。 |
日志审计对象
| 字段 | 类型 | 说明 |
|---|---|---|
action | string | 动作:disable 停用;enable 启用。 |
actor_id | integer | 操作者 ID。 |
actor_name | string | 操作者名称(用户名);系统任务或查不到时缺省。 |
actor_type | string | 操作者类型:user 用户、admin 管理员、system 系统、node 节点。 |
channel | string | 发送渠道:email 邮件;sms 短信;webhook 告警 Webhook。 |
client | string | 登录客户端,由 User-Agent 按子串解析成「浏览器 · 系统」(如 Chrome · macOS);认不出或旧记录没有时不返回。 |
content | string | 切换说明。 |
created_at | string | 创建时间 |
detail | object | 操作详情(JSON 对象)。 |
error | string | 最近一次失败的错误;成功为空。 |
geo | GeoipLookup | IP 归属地查询结果。 |
id | integer | 记录 ID |
ip | string | 被切换的 IP。 |
kind | string | 消息类型或直发类别(verify_code 等)。 |
line_id | integer | 线路 ID。 |
method | string | 登录方式:password 口令登录;sso 超管代登录(凭超管签发的一次性登录票);admin_switch 面板管理员切换到该租户。 |
msg_id | integer | 关联的站内信 ID;直发类为空。 |
node_group_id | integer | 节点组 ID。 |
node_id | integer | 节点 ID |
reason | string | 失败原因机器码;成功为空。 |
request_id | string | 请求 ID,用于关联日志。 |
source | string | 操作经由:ai = 用户在 AI 助手计划卡上点执行(detail.ai 带计划号、接口、模型);直接在面板或接口操作时缺省。 |
sso_kid | string | 超管代登录时签票的 sso 钥 kid;口令登录不返回。 |
state | string | 发送状态:done 成功;failed 失败。 |
success | boolean | 登录是否成功。 |
target_deleted | boolean | 对象已被删除(可联表的类型且联表查不到)。 |
target_id | string | 操作对象 ID。 |
target_name | string | 对象名:优先取记录时的快照,老记录按 target_type 与 target_id 联表取当前名;取不到缺省。 |
target_type | string | 操作对象类型。 |
tenant_id | integer | 所属租户(用户)ID |
title | string | 消息标题(直发类为空)。 |
to | string | 打码后的收件人;webhook 通道为「类型/名称」。 |
tries | integer | 发送尝试次数。 |
type | string | manual = 管理员手工;monitor = 节点监控自动停用/恢复节点;bandwidth = 节点带宽超限自动停用/回落后恢复;backup = 节点组自动切到备用组(enable)/切回(disable);backup_ip = 线路备用 IP 自动启用(enable)/撤下(disable);backup_default = 线路默认线路兜底自动启用(enable)/改回原线路(disable);drain = 节点升级重启 nginx 前主动申请摘出解析(disable)/自检通过或超时收回后加回(enable),不发通知。 |
updated_at | string | 更新时间 |
user_agent | string | 登录时的 User-Agent 原文(库里已按长度截断);旧记录没有时不返回。client 认不出来时面板用它的首段兜底、悬停显示全文。 |
user_id | integer | 用户 ID |
username | string | 用户名 |
webhook_id | integer | webhook 通道的 Webhook id(同一条消息发多个 Webhook 各记一行);其他通道为空。 |
webhook_name | string | webhook 通道的 Webhook 当前名称;该 Webhook 已删除则为空。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}