GET/api/v1/admin/audit-logs检索审计日志

Try it 面板需要启用 JavaScript。

跨全部用户与动作分页检索审计事件。

Request

Headers

Name	Data Type	Required	Description
Authorization	string	Yes	会话令牌认证，格式 `Bearer <sessionToken>`

type RequestHeaders = {
  /** 会话令牌认证，格式 `Bearer <sessionToken>` */
  Authorization: string
}

Query Parameters

Name	Data Type	Required	Description
page	number	No	页码，默认 1
pageSize	number	No	每页数量，默认 20，上限 100
userId	string	No	按行为主体过滤
action	string	No	按动作过滤，如 auth.login.password
resource	string	No	按资源过滤
result	string	No	success / failure
since	string	No	起始时间（ISO 8601 UTC）
until	string	No	结束时间（ISO 8601 UTC）

type QueryParams = {
  /** 页码，默认 1 */
  page?: number
  /** 每页数量，默认 20，上限 100 */
  pageSize?: number
  /** 按行为主体过滤 */
  userId?: string
  /** 按动作过滤，如 auth.login.password */
  action?: string
  /** 按资源过滤 */
  resource?: string
  /** success / failure */
  result?: string
  /** 起始时间（ISO 8601 UTC） */
  since?: string
  /** 结束时间（ISO 8601 UTC） */
  until?: string
}

{
  "page": 1,
  "pageSize": 20,
  "action": "auth.login.password",
  "result": "failure"
}

Response

Body

Name	Data Type	Required	Description
items	array	Yes	日志列表
total	number	Yes	总数
page	number	Yes	当前页码
pageSize	number	Yes	每页数量

type ResponseBody = {
  /** 日志列表 */
  items: Record<string, unknown>[]
  /** 总数 */
  total: number
  /** 当前页码 */
  page: number
  /** 每页数量 */
  pageSize: number
}

{
  "items": [
    {
      "logId": "01JD8SNXER6Y9Z5FZ",
      "actorId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
      "action": "auth.login.password",
      "resource": "user/01JD8SEGQ0P9N2XK4L7VDH3T6C",
      "result": "failure",
      "ip": "198.51.100.7",
      "detail": "密码错误",
      "occurredAt": "2026-10-14T07:58:12Z"
    }
  ],
  "total": 8521,
  "page": 1,
  "pageSize": 20
}

HTTP Code

HTTP Status	Meaning	Notes
200	成功	返回日志列表

Response Code

响应使用统一信封 {id, code, messages, result}，其 code 字段：

code	Meaning	Notes
0	成功	返回日志列表

Examples

GET /api/v1/admin/audit-logs?action=auth.login.password&result=failure
Authorization: Bearer st_7c1f9e05b28d4a63

{
  "id": "01JD8STH7M2H5I9",
  "code": 0,
  "messages": [],
  "result": {
    "items": [
      {
        "logId": "01JD8SNXER6Y9Z5FZ",
        "actorId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
        "action": "auth.login.password",
        "resource": "user/01JD8SEGQ0P9N2XK4L7VDH3T6C",
        "result": "failure",
        "ip": "198.51.100.7",
        "detail": "密码错误",
        "occurredAt": "2026-10-14T07:58:12Z"
      }
    ],
    "total": 8521,
    "page": 1,
    "pageSize": 20
  }
}