查询实例的SQL洞察（SQL审计）文件内容V2
更新时间 2025-10-15 13:49:29
最近更新时间: 2025-10-15 13:49:29
接口功能介绍
调用接口查询实例的SQL洞察（SQL审计）文件内容
接口约束
无
URI
GET /RDS2/v2/open-api/audit-log/search-file
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| outerProdInstId | 是 | String | 实例ID | eddf4d2c6d67407ba39e3453ee0776ca | |
| resId | 是 | Integer | 资源id | 305 | |
| sourceIdentifier | 是 | String | 文件唯一标识 | audit_archive_1724124937000_1724150269000.log | |
| keyWord | 否 | String | 关键字 | ||
| user | 否 | String | 用户名 | ||
| db | 否 | String | 数据库 | ||
| commandClass | 否 | String | 操作类型：select,insert,update,delete,alter,create,drop,show,other | select | |
| status | 否 | String | 状态 0成功 1失败 | 0 | |
| clientIP | 否 | String | 客户端IP | 127.0.0.1 | |
| startTime | 否 | String | 开始时间（建议等于或大于文件首行记录时间） | yyyy-MM-dd HH:mm:ss | |
| endTime | 否 | String | 结束时间（建议等于或小于文件尾行记录时间） | yyyy-MM-dd HH:mm:ss | |
| pageNow | 否 | Integer | 当前页 | 1 | |
| pageSize | 否 | Integer | 单页记录条数 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 否 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源池regionId，比如实例在资源池A，则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功 | 0 | |
| message | String | 返回消息 | ||
| returnObj | Object | 分页信息 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | 1 | |
| size | Integer | 当前页的数量 | 0 | |
| startRow | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
| endRow | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
| total | Integer | 总记录数 | 1 | |
| pages | Integer | 总页数 | 1 | |
| lastPage | Integer | 最后一页 | 1 | |
| nextPage | Integer | 下一页 | 1 | |
| firstPage | Integer | 第一页 | 1 | |
| prePage | Integer | 前一页 | 1 | |
| isFirstPage | Boolean | 是否为第一页 | ||
| isLastPage | Boolean | 是否为最后一页 | ||
| hasPreviousPage | Boolean | 是否有前一页 | ||
| hasNextPage | Boolean | 是否有下一页 | ||
| navigatePages | Integer | 导航页码数 | 1 | |
| navigateLastPage | Integer | 页面上显示的最后一个页码 | 1 | |
| navigateFirstPage | Integer | 页面显示的第一个页码 | 1 | |
| navigatepageNums | Array of Integers | 所有导航页号 | pageNum | |
| list | Array of Objects | 结果集(每页显示的数据 | T | |
| 表 T |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| sqlText | String | sql语句 | ||
| commandClass | String | 命令类型 | select | |
| status | Integer | 运行状态 0正常 1失败 | 1 | |
| user | String | 用户名 | ||
| db | String | 数据库名 | ||
| clientIP | String | 客户端IP | 127.0.0.1 | |
| timestamp | String | 记录生成时间，格式为：yyyy-MM-dd HH:mm:ss | 2024-08-20 13:52:24 | |
| record | String | 记录标识 | 84254_2024-08-20T03:50:24 | |
| connectionId | String | 线程ID |
枚举参数
无
请求示例
请求url
/RDS2/v2/open-api/audit-log/search-file?outerProdInstId=b829cb71308746a094853c21d5aac0a1Z&resId=305&sourceIdentifier=audit_archive_1724124937000_1724150269000.log&commandClass=create&startTime=2024-08-20 18:13:20&endTime=2024-08-20 19:13:20
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [
1
],
"startRow": 0,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 0,
"pageSize": 1,
"list": [
{
"sqlText": "",
"commandClass": "create_table",
"record": "84254_2024-08-20T03:50:24",
"connectionId": "868",
"user": "root",
"db": "test01",
"status": "0",
"timestamp": "2024-08-20 18:37:48"
}
],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 36,
"pages": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
请参考 状态码
错误码
请参考 错误码
