日志

# 概述

日志

类名

LogApi.java

成员方法

名称	方法	Method	Path
添加日志格式化模板	addLogFormat	POST	/api-organization/log/addLogFormat
添加日志数据	addUserLog	POST	/api-organization/log/addUserLog
删除日志格式化模板	deleteLogFormat	POST	/api-organization/log/deleteLogFormat
删除日志	deleteUserLog	POST	/api-organization/log/deleteUserLog
获取日志格式化模板列表	getLogFormatList	POST	/api-organization/log/getLogFormatList
获取日志列表	getUserLogList	POST	/api-organization/log/getUserLogList
修改日志格式化模板	updateLogFormat	POST	/api-organization/log/updateLogFormat

# 添加日志格式化模板

ResultObject addLogFormat(addLogFormatForm)

根据form类添加

# 请求参数

名称	类型	描述	备注
addLogFormatForm	AddLogFormatForm	addLogFormatForm

# AddLogFormatForm

名称	类型	描述	备注
formatTemplate	String	格式化模板	-
languageType	String	语言类型 (zh-cn
moduleId	String	模块Id（属于那个日志的模板）sys-mncloud: 业务平台; sys-super: super平台; sys-wxapp: APP/微信小程序; 其它自定义模块Id
name	String	名称
requestUri	String	请求路径

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
AddLogFormatForm addLogFormatForm = new AddLogFormatForm();

try {
    ResultObject result = apiInstance.addLogFormat(addLogFormatForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.addLogFormat异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/addLogFormat
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"name":"",
	"languageType":"",
	"requestUri":"",
	"formatTemplate":"",
	"moduleId":""
}

1
2
3
4
5
6
7

# 添加日志数据

ResultObject addUserLog(addUserLogForm)

根据传入的Form类添加日志

# 请求参数

名称	类型	描述	备注
addUserLogForm	AddUserLogForm	addUserLogForm

# AddUserLogForm

名称	类型	描述	备注
clientIp	String	请求端IP	-
companyId	String	企业Id	-
details	String	日志详情	-
oldDataMigration	String	老数据迁移，0：不是，1，是	-
projectId	String	项目Id	-
requestUri	String	请求路径	-
requestUrl	String	请求地址	-
resultCode	String	操作返回码	-
resultData	String	返回值信息	-
resultMessage	String	返回值信息	-
userId	String	用户Id	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
AddUserLogForm addUserLogForm = new AddUserLogForm();

try {
    ResultObject result = apiInstance.addUserLog(addUserLogForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.addUserLog异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/addUserLog
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"oldDataMigration":"",
	"companyId":"",
	"resultData":"",
	"requestUrl":"",
	"clientIp":"",
	"resultCode":"",
	"details":"",
	"requestUri":"",
	"resultMessage":"",
	"projectId":"",
	"userId":""
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# 删除日志格式化模板

ResultObject deleteLogFormat(deleteType, id)

根据Id删除

# 请求参数

名称	类型	描述	备注
deleteType	String	删除类型 all：删除该uri下的所有模板为空则删除当前传入的模板	-
id	String	日志格式化模板Id	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
String deleteType = "deleteType_example";
String id = "id_example";

try {
    ResultObject result = apiInstance.deleteLogFormat(deleteType, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.deleteLogFormat异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/deleteLogFormat
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"deleteType":"",
	"id":""
}

1
2
3
4

# 删除日志

ResultObject deleteUserLog(logIds)

根据传入的N个日志ID 删除

# 请求参数

名称	类型	描述	备注
logIds	List<String>	N个日志ID	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
List<String> logIds = Arrays.asList(new List<String>());

try {
    ResultObject result = apiInstance.deleteUserLog(logIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.deleteUserLog异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/deleteUserLog
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"logIds":[]
}

1
2
3

# 获取日志格式化模板列表

ResultIPageSysLogLanguageFormat getLogFormatList(logFormatParam)

获取日志格式化模板

# 请求参数

名称	类型	描述	备注
logFormatParam	LogFormatParam	logFormatParam

# LogFormatParam

名称	类型	描述	备注
currentPage	Integer	当前页码
keyword	String	模糊搜索	-
languageType	String	语言类型 (zh_cn	-
moduleId	String	模块Id（获取指定模块的日志）为空: 全部; sys-mncloud: 业务平台; sys-super: super平台; sys-wxapp: APP/微信小程序; 其它自定义模块Id	-
pageSize	Integer	每页个数
requestUri	String	请求路径	-

# 返回参数

ResultIPageSysLogLanguageFormat

名称	类型	描述	备注
code	String	响应码	-
data	IPageSysLogLanguageFormat	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

IPageSysLogLanguageFormat

名称	类型	备注
current	Long	-
hitCount	Boolean	-
pages	Long	-
records	List<SysLogLanguageFormat>	-
searchCount	Boolean	-
size	Long	-
total	Long	-

SysLogLanguageFormat

名称	类型	描述	备注
formatTemplate	String	格式化模板	-
id	String	主键id	-
languageType	String	语言类型	-
moduleId	String	模块Id（获取指定模块的日志） sys-mncloud: 业务平台; sys-super: super平台; sys-wxapp: APP/微信小程序; 其它自定义模块Id	-
name	String	日志描述	-
requestUri	String	请求路径	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
LogFormatParam logFormatParam = new LogFormatParam();

try {
    ResultIPageSysLogLanguageFormat result = apiInstance.getLogFormatList(logFormatParam);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.getLogFormatList异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/getLogFormatList
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"languageType":"",
	"pageSize":0,
	"requestUri":"",
	"currentPage":0,
	"keyword":"",
	"moduleId":""
}

1
2
3
4
5
6
7
8

# 获取日志列表

ResultIPageUserLog getUserLogList(userLogParam)

分页查询日志列表

# 请求参数

名称	类型	描述	备注
userLogParam	UserLogParam	userLogParam

# UserLogParam

名称	类型	描述	备注
currentPage	Integer	当前页码
endTime	String	结束日期（日期选择范围只能在一个月内）
pageSize	Integer	每页个数
projectId	String	该值为空时默认查询企业日志	-
startTime	String	开始日期（日期选择范围只能在一个月内）

# 返回参数

ResultIPageUserLog

名称	类型	描述	备注
code	String	响应码	-
data	IPageUserLog	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

IPageUserLog

名称	类型	备注
current	Long	-
hitCount	Boolean	-
pages	Long	-
records	List<UserLog>	-
searchCount	Boolean	-
size	Long	-
total	Long	-

UserLog

名称	类型	描述	备注
clientIp	String	请求端IP	-
companyId	String	企业Id	-
details	String	日志详情	-
id	String	日志Id	-
nickname	String	用户名	-
oldDataMigration	String	老数据迁移，0：不是，1，是	-
projectId	String	项目Id	-
requestTime	String	记录时间	-
resultCode	String	操作返回码	-
resultData	String	返回值信息	-
resultMessage	String	返回值信息	-
userId	String	用户Id	-
username	String	用户账号	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
UserLogParam userLogParam = new UserLogParam();

try {
    ResultIPageUserLog result = apiInstance.getUserLogList(userLogParam);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.getUserLogList异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/getUserLogList
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"pageSize":0,
	"startTime":"",
	"endTime":"",
	"currentPage":0,
	"projectId":""
}

1
2
3
4
5
6
7

# 修改日志格式化模板

ResultObject updateLogFormat(formatTemplate, id)

根据Id修改 (只供修改格式化模板信息)

# 请求参数

名称	类型	描述	备注
formatTemplate	String	格式化模板	-
id	String	日志格式化模板Id	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
LogApi apiInstance = new LogApi(token);
//实例化请求参数
String formatTemplate = "formatTemplate_example";
String id = "id_example";

try {
    ResultObject result = apiInstance.updateLogFormat(formatTemplate, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用LogApi.updateLogFormat异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/log/updateLogFormat
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"formatTemplate":"",
	"id":""
}

1
2
3
4

← 权限组消息推送→

日志

# 概述

# 添加日志格式化模板

# 请求参数

# AddLogFormatForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 添加日志数据

# 请求参数

# AddUserLogForm

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 删除日志格式化模板

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 删除日志

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 获取 日志格式化模板列表

# 请求参数

# LogFormatParam

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 获取日志列表

# 请求参数

# UserLogParam

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 修改日志格式化模板

# 请求参数

# 返回参数

# java-sdk 调用示例

# HTTP 调用示例

# 获取日志格式化模板列表