接口功能介绍
调用接口查询实例的SQL洞察(SQL审计)日志。
接口约束
无
URI
GET /v1/open-api/audit-log
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | ||
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 单页记录条数 | ||
startTime | 否 | String | 开始时间 | yyyy-MM-dd HH:mm:ss | |
endTime | 否 | String | 结束时间 | yyyy-MM-dd HH:mm:ss | |
user | 否 | String | 用户名 | ||
db | 否 | String | 数据库 | ||
commandClass | 否 | String | 操作类型 | select update | commandClass枚举 |
keyWord | 否 | String | 关键字 | ||
status | 否 | String | 状态 0成功 1失败 | 0 |
commandClass 枚举
枚举值 |
---|
select |
insert |
update |
delete |
alter |
create |
drop |
show |
other |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码取值范围:0 成功 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | PageInfo | 分页信息 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNum | 是 | Integer | 当前页 | 1 | |
pageSize | 是 | Integer | 每页的数量 | 1 | |
size | 是 | Integer | 当前页的数量 | 0 | |
startRow | 是 | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
endRow | 是 | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
total | 是 | Integer | 总记录数 | ||
pages | 是 | Integer | 总页数 | ||
firstPage | 是 | Integer | 第一页 | ||
nextPage | 是 | Integer | 下一页 | 1 | |
lastPage | 是 | Integer | 最后一页 | ||
prePage | 是 | Integer | 前一页 | ||
isFirstPage | 是 | Boolean | 是否为第一页 | ||
isLastPage | 是 | Boolean | 是否为最后一页 | ||
hasPreviousPage | 是 | Boolean | 是否有前一页 | ||
hasNextPage | 是 | Boolean | 是否有下一页 | ||
navigatePages | 是 | Integer | 导航页码数 | ||
navigateLastPage | 是 | Integer | 页面上显示的最后一个页码 | ||
navigateFirstPage | 是 | Integer | 页面显示的第一个页码 | ||
navigatepageNums | 是 | Array of Integer | 所有导航页号 | ||
list | 是 | Array of Objects | 结果集(每页显示的数据) | T |
列表信息
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sqlText | 是 | String | sql语句 | ||
sqlDigest | 是 | String | sql摘要 | ||
commandClass | 是 | String | 命令类型 | select | |
commandCode | 是 | Tinyint | 命令code | ||
ip | 是 | String | 客户端Ip | ||
host | 是 | String | 数据库Ip | ||
status | 是 | Tinyint | 运行状态 0正常 1失败 | ||
user | 是 | String | 用户名 | ||
db | 是 | String | 数据库名 | ||
createTime | 是 | Long | 创建时间 | ||
connectionId | 是 | String | 线程ID |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"lastPage": 5,
"navigatepageNums": [
1,
2,
3,
4,
5
],
"startRow": 1,
"hasNextPage": true,
"prePage": 0,
"nextPage": 2,
"endRow": 2,
"pageSize": 2,
"list": [
{
"sqlText": "select * from inspection_task",
"createTime": 1664271512000,
"port": "9095",
"commandClass": "select",
"commandCode": false,
"ip": "",
"sqlDigest": "594c40464ec462631bd036c0965c164c",
"host": "192.168.203.131",
"connectionId": "34238",
"user": "ych",
"db": "",
"status": "0"
},
{
"sqlText": "show tables",
"createTime": 1664271489000,
"port": "9095",
"commandClass": "show_tables",
"commandCode": false,
"ip": "",
"sqlDigest": "489b4ceb2f4301a7132628303f99240d",
"host": "192.168.203.131",
"connectionId": "34248",
"user": "ych",
"db": "",
"status": "0"
}
],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 10,
"pages": 5,
"firstPage": 1,
"size": 2,
"isLastPage": false,
"hasPreviousPage": false,
"navigateLastPage": 5,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |