方法路径摘要认证
GET/v1/audit-logsList rendered operation log rows, newest first登录会话
GET/v1/audit-logs/categoriesEvent categories with labels and default retention days登录会话
GET/v1/audit-logs/exportExport the filtered rows as UTF-8 CSV (at most 10000 rows; the export itself is audited as system.audit_log.export)登录会话

契约文件:api/control-audit-logs.openapi.yaml

接口详情

GET /v1/audit-logs

List rendered operation log rows, newest first

operationId
listAuditLogs
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

全部需要:platform.admin identity.self.read

参数

listAuditLogs 参数
名称位置类型必填说明
categoryquerystring | const all否—
exclude_categoryquerystring否Drop one category (the admin log center's operation tab excludes auth)
scope_idquerystring(uuid)否Platform administrators only; tenants may only pass their own scope
sincequerystring(date-time)否—
untilquerystring(date-time)否—
actorquerystring否Username (exact
actor_user_idquerystring(uuid)否—
source_ipquerystring否—
resource_typequerystring否—
resource_idquerystring否—
resultquerystring: success / denied / failure否—
actionquerystring否—
cursorquerystring否—
limitqueryinteger否—
tzquerystring否IANA time zone for the rendered time (default Asia/Shanghai)
langquerystring否Overrides Accept-Language

响应

listAuditLogs 响应
状态码说明
200One page of rows

字段:items: array<Row> next_cursor?: string

400Invalid filter (audit_log_invalid_request)
401Unauthenticated
403Permission denied
503Log storage unavailable (audit_log_unavailable)

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表

GET /v1/audit-logs/categories

Event categories with labels and default retention days

operationId
listAuditLogCategories
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

全部需要:platform.admin identity.self.read

参数

listAuditLogCategories 参数
名称位置类型必填说明
langquerystring否Overrides Accept-Language

响应

listAuditLogCategories 响应
状态码说明
200Categories in display order

字段:items: array<CategoryInfo>

401Unauthenticated
403Permission denied

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。

↑ 回到列表

GET /v1/audit-logs/export

Export the filtered rows as UTF-8 CSV (at most 10000 rows; the export itself is audited as system.audit_log.export)

operationId
exportAuditLogs
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

全部需要:platform.admin identity.self.read

响应

exportAuditLogs 响应
状态码说明
200CSV file
400Invalid filter (audit_log_invalid_request)
401Unauthenticated
403Permission denied
503Log storage or audit unavailable (audit_log_unavailable)

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表