Skip to content

L
log-platform
Commit 35bcc3ff authored by 赵啸非's avatar 赵啸非
Browse files
Options

异常日志前端展示添加

parent f881b38e
Show whitespace changes
Inline Side-by-side
Showing with 24 additions and 361 deletions
doc/api.md
View file @ 35bcc3ff
# 服务平台 # 日志服务平台
版本 | 创建时间 | 作者 | 备注信息 版本 | 创建时间 | 作者 | 备注信息
---|---|---|--- ---|---|---|---
v1.0|2022-01-20|zxfei| 接口文档 v1.0|2022-01-20|zxfei| 接口文档
...@@ -15,203 +15,6 @@ object|对象类型|{"name":"zhang3"} ...@@ -15,203 +15,6 @@ object|对象类型|{"name":"zhang3"}
arrays|数组类型|[{"name":"zhang3"},{"name":"zhang2"}] arrays|数组类型|[{"name":"zhang3"},{"name":"zhang2"}]
## 系统服务
### 登录
**请求URL:** login/login
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户登录
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
loginName|String|用户名称|是|-
password|String|用户密码|是|-
securityCode|String|校验码|是|-
**请求样例:**
```
{
"loginName":"zhang3",
"password":"123456",
"securityCode":"5455"
}
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"msg":"登录成功",
"code":1,
"data":{
}
}
```
### 登出
**请求URL:** login/logout
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户退出注销
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
**请求样例:**
```
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
```
### 修改密码
**请求URL:** user/change/password
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户修改密码
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
loginName|String|用户名称|是|-
oldPwd|String|用户加密后密码|是|-
newPwd|String|用户加密后新密码|是|-
**请求样例:**
```
{
"loginName":"zhang3",
"oldPwd":"123456",
"newPwd":"5455"
}
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"msg":"修改密码成功",
"code":1,
"data":{}
}
```
### 获取验证码
**请求URL:** securitycode/createCode
**请求方式:** GET
**内容类型:** image/gif
**简要描述:** 用户退出注销
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
**请求样例:**
```
```
**响应参数:**
**响应消息样例:**
```
```
### 上传附件
**请求URL:** file/commonupload
**请求方式:** POST
**内容类型:** multipart/form-data
**简要描述:** 用户上传附件
**请求参数:**
参数名称|类型|备注|必填|其它
---|---|---|---|---
file|multipart|附件|是|-
prePath|String|附件存放相对路径|否|不填时候默认为/file/fileupload
**请求样例:**
```
http://127.0.0.1/file/commonupload?prePath=/file/fileupload
Content-Type: multipart/form-data; boundary=WebAppBoundary
--WebAppBoundary
Content-Disposition: form-data; name="file"; filename="1.excel"
Content-Type: multipart/form-data
```
**响应参数:**
**响应消息样例:**
```
```
## 平台用户操作日志业务 ## 平台用户操作日志业务
### 查询平台用户操作日志业务列表 ### 查询平台用户操作日志业务列表
...@@ -344,7 +147,7 @@ dict|object|字典对象 ...@@ -344,7 +147,7 @@ dict|object|字典对象
**内容类型:** application/json;charset=utf-8 **内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新平台用户操作日志业务：id为空时为新增保存，否则为更新提交 **简要描述:** 保存平台用户操作日志业务
**请求参数:** **请求参数:**
...@@ -363,15 +166,15 @@ operType|Integer|否|操作类型，0：新增，1：修改，2：删除 ...@@ -363,15 +166,15 @@ operType|Integer|否|操作类型，0：新增，1：修改，2：删除
**请求样例:** **请求样例:**
``` ```
{ {
"platformMark":"7iw3sc", "platformMark":"log-platform",
"userId":7212, "userId":1,
"userName":"wbpriu", "userName":"张三",
"loginName":"aet2rq", "loginName":"zhang3",
"requestUrl":"5ua2fd", "requestUrl":"/xxx",
"content":"0slnl4", "content":"短信记录 新增",
"ip":"p340fy", "ip":"192.168.0.95",
"logDate":"2022-08-25", "logDate":"2022-08-25",
"operType":5047, "operType":0,
} }
``` ```
...@@ -408,41 +211,6 @@ data|object|数据对象 ...@@ -408,41 +211,6 @@ data|object|数据对象
``` ```
### 删除平台用户操作日志业务
**请求URL:** operate/log/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除平台用户操作日志业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/operate/log/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 访问日志 ## 访问日志
### 查询访问日志列表 ### 查询访问日志列表
...@@ -602,7 +370,7 @@ dict|object|字典对象 ...@@ -602,7 +370,7 @@ dict|object|字典对象
**内容类型:** application/json;charset=utf-8 **内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新访问日志：id为空时为新增保存，否则为更新提交 **简要描述:** 保存访问日志
**请求参数:** **请求参数:**
...@@ -631,23 +399,23 @@ schemaData|String|否|协议 ...@@ -631,23 +399,23 @@ schemaData|String|否|协议
``` ```
{ {
"traceID":"lgse97", "traceID":"lgse97",
"pspanId":949, "pspanId":1,
"spanId":5937, "spanId":0,
"appName":"fnxe1s", "appName":"base-platform",
"hostName":"l5emnm", "hostName":"l5emnm",
"targetServer":"86a47d", "targetServer":"device-platform",
"logLevel":"9s9bk2", "logLevel":"9s9bk2",
"requestIp":"5ricie", "requestIp":"192.168.0.96",
"method":"oza7x8", "method":"post",
"ua":"8bzvfh", "ua":"xxx",
"uri":"x5fbfq", "uri":"/xxx/xx",
"requestData":"mmbhs8", "requestData":"mmbhs8",
"responseData":"jzlxtk", "responseData":"jzlxtk",
"logTime":"2022-08-25", "logTime":"2022-08-25",
"requestTime":"2022-08-25", "requestTime":"2022-08-25",
"responseTime":"2022-08-25", "responseTime":"2022-08-25",
"duration":9041, "duration":12,
"schemaData":"9el561" "schemaData":"http"
} }
``` ```
...@@ -693,41 +461,6 @@ data|object|数据对象 ...@@ -693,41 +461,6 @@ data|object|数据对象
``` ```
### 删除访问日志
**请求URL:** access/log/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除访问日志
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/access/log/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 业务日志 ## 业务日志
### 查询业务日志列表 ### 查询业务日志列表
...@@ -855,7 +588,7 @@ dict|object|字典对象 ...@@ -855,7 +588,7 @@ dict|object|字典对象
} }
``` ```
### 保存更新业务日志 ### 保存业务日志
**请求URL:** biz/log/save **请求URL:** biz/log/save
...@@ -863,7 +596,7 @@ dict|object|字典对象 ...@@ -863,7 +596,7 @@ dict|object|字典对象
**内容类型:** application/json;charset=utf-8 **内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新业务日志：id为空时为新增保存，否则为更新提交 **简要描述:** 保存业务日志
**请求参数:** **请求参数:**
...@@ -930,41 +663,6 @@ data|object|数据对象 ...@@ -930,41 +663,6 @@ data|object|数据对象
``` ```
### 删除业务日志
**请求URL:** biz/log/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除业务日志
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/biz/log/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 异常日志 ## 异常日志
### 查询异常日志列表 ### 查询异常日志列表
...@@ -1134,7 +832,7 @@ dict|object|字典对象 ...@@ -1134,7 +832,7 @@ dict|object|字典对象
} }
``` ```
### 保存更新异常日志 ### 保存异常日志
**请求URL:** error/log/save **请求URL:** error/log/save
...@@ -1231,41 +929,6 @@ data|object|数据对象 ...@@ -1231,41 +929,6 @@ data|object|数据对象
``` ```
### 删除异常日志
**请求URL:** error/log/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除异常日志
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/error/log/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 字典附录 ## 字典附录
### platform ### platform
字典参数key|字典参数值|其它 字典参数key|字典参数值|其它
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment