搜索管理员登录审计

1. 接口定位

• 接口名称: 搜索管理员登录审计
• 所属域: admin/account
• 业务目标: 按账号、管理员 userID、IP、成功状态和时间范围分页检索 adminx 登录审计记录

2. 请求定义

• Method: POST
• Path: /adminx/account/login_audit/search
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 幂等

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

字段	必填	类型	说明
keyword	否	string	对 account、userID、ip 做不区分大小写模糊匹配
hasSuccess	否	bool	是否启用 success 过滤；false 表示忽略成功状态筛选
success	否	bool	登录是否成功；仅 hasSuccess=true 时生效
start	否	int64	起始时间，Unix 毫秒时间戳，闭区间起点
end	否	int64	结束时间，Unix 毫秒时间戳，开区间终点
pagination	是	object	分页参数

pagination 字段

字段	必填	类型	说明
pageNumber	是	int32	页码，从 1 开始
showNumber	是	int32	每页条数，大于 0

字段约束

• pagination 不能为空。
• pageNumber 和 showNumber 都必须大于 0。
• 当 start 和 end 同时传入时，要求 start <= end。

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	object	业务数据

data 字段

字段	类型	说明
total	uint32	命中的审计记录总数
audits	array<object>	当前页审计记录列表

audits 元素字段

字段	类型	说明
userID	string	管理员 userID
account	string	管理员账号
ip	string	登录来源 IP
userAgent	string	登录请求 User-Agent
success	bool	本次登录是否成功
reason	string	失败原因；成功记录通常为空
loginTime	int64	登录时间，Unix 毫秒时间戳

5. 业务规则

• 仅管理员可以调用。
• 审计记录按 loginTime 倒序返回。
• keyword 只匹配 account、user_id、ip，当前不会按 userAgent 做搜索。
• hasSuccess=false 时，无论 success 传什么值，都不会按成功状态过滤。
• start 为闭区间起点，end 为开区间终点。
• 当前接口直接返回审计原始记录，不会额外补充管理员资料。
• 记录来源覆盖：
  • 未开启 2FA 的直接登录成功；
  • 开启 2FA 后的最终成功登录；
  • 密码错误、管理员已被封禁、TOTP 校验失败等失败场景。

6. 错误码与失败场景

错误码	场景	典型报错
1001	pagination 为空	pagination is empty
1001	分页参数非法	pagination invalid
1001	start > end	start > end
-	审计数据搜索失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

fetch("http://localhost:10011/adminx/account/login_audit/search", {
  method: "POST",
  headers: {
    operationID: "adminx-login-audit-search-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    keyword: "root_admin",
    hasSuccess: true,
    success: false,
    start: 1773417600000,
    end: 1773504000000,
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "keyword": "root_admin",
  "hasSuccess": true,
  "success": false,
  "start": 1773417600000,
  "end": 1773504000000,
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "audits": [
      {
        "userID": "1000000001",
        "account": "root_admin",
        "ip": "203.0.113.10",
        "userAgent": "Mozilla/5.0",
        "success": false,
        "reason": "invalid totp code",
        "loginTime": 1773421200000
      }
    ]
  }
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "start > end"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验分页参数与时间范围。
3. 组装 keyword、成功状态、时间窗口过滤条件。
4. 按 loginTime 倒序分页查询审计记录。
5. 组装 total + audits 返回。

9. 变更记录

• 2026-04-14: 首版发布，新增 adminx 管理员登录审计查询接口文档。