跳转至

设计时操作日志查询(LogController)

分页查询指定应用下的运行时操作日志,可按操作类型、操作人、源对象 id 过滤;供设计器日志查看页使用。

  • 接口类型:REST 资源
  • 基址${myapps.context-path.designer:}/api/designtime/applications(类级 @RequestMappingproduces = APPLICATION_JSON_VALUE
  • Tag:设计时-日志模块

公共说明

  • 鉴权:是(需 designerToken)。控制器继承自 AbstractDesignTimeController(基类为 @RestController,bean 名 designer-log-controller)。鉴权机制详见 index.md「鉴权说明」。
  • 路径变量{applicationId} 为**明文设计时 ID**。
  • 响应:统一 Resource(见 ../index.md「统一响应结构」)。成功 errcode=0;异常 errcode=500
  • HTTP 方法:受 CommonSecurityFilter 限制,仅允许 GET/POST/HEAD/OPTIONS
  • 数据来源:通过 RunTimeServiceManager.logProcess(applicationId) 取得运行时日志服务,查询的是运行时库的日志数据。

1. 获取日志列表

分页查询指定应用下的操作日志,可按操作类型、操作人、源对象 id 过滤。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/{applicationId}/logs(完整:{designer-context}/api/designtime/applications/{applicationId}/logs
  • 鉴权:是(需 designerToken)
  • Tag:设计时-日志模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 软件 id
type query string 操作类型(如新增/更新/删除等)
operator query string 操作人
sourceId query string 源对象 id
pageNo query int 当前页数(缺省 1
linesPerPage query int 每页行数(缺省 10

说明:@Parameter 标注 pageNo/linesPerPagerequired=true,但 @RequestParam 实际声明了 defaultValue = "1"/"10",故缺省时按默认值处理。

请求示例

GET /api/designtime/applications/{applicationId}/logs?type=&operator=&sourceId=&pageNo=1&linesPerPage=10 HTTP/1.1

响应

结构:统一 Resource(见 ../index.md「统一响应结构」)。 dataDataPackage<LogVO>(含分页字段与 datas,每条日志含操作时间、操作人、操作类型、源对象、摘要等)。

成功示例

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageNo": 1,
    "pageCount": 1,
    "rowCount": 1,
    "datas": [
      { "id": "...", "operator": "...", "type": "...", "sourceId": "...", "summary": "...", "...": "..." }
    ]
  },
  "errors": null
}
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }