接口描述

查询RDS实例的SQL洞察（SQL审计）日志

接口约束

URI

GET /v1/collector/sql-log-records

请求参数

请求体Query参数

参数	是否必填	参数类型	说明	示例
prodInstId	是	Long	实例id	10
pageNum	是	Integer	页码最小值为1	1
pageSize	是	Integer	页大小取值范围为：1-500	10
dbName	否	String	数据库名称。默认为所有数据库，也可以输入数据库名称查询，一次只能输入一个	test
accountName	否	String	用户名称。默认为所有用户，也可以输入用户名称查询，一次只能输入一个	root
startTime	是	String	查询开始时间,格式：yyyy-MM-dd HH:mm:ss
endTime	是	String	查询结束时间,大于查询开始时间，与查询开始时间间隔小于等于30天,格式：yyyy-MM-dd HH:mm:ss
queryKeywords	否	List	用于查询的关键字, 1.多个关键字以空格分隔，不超过10个关键字 2.如果SQL语句中的字段名使用了反引号（`），以该字段名作为查询的关键字时，也需要输入反引号。例如，字段名为`id `，则输入`id`，而不是id	SELECT

响应参数

参数	参数类型	说明	示例
statusCode	Integer	状态码	800
message	String	消息提示	SUCCESS
returnObj	PageVO	返回对象

PageVO

参数	参数类型	说明	示例	下级对象
pageNum	Integer	页码	1
pageSize	Integer	页大小	10
pageTotal	Integer	总页数	1
total	Integer	总记录数	2
list	List	记录		DescribeSQLLogRecordsVO

DescribeSQLLogRecordsVO

参数	参数类型	说明	示例
hostAddress	String	连接数据库的客户端IP地址	192.168.0.18:50744
sqlText	String	SQL语句	terminating connection due to administrator command
dbName	String	数据库名称	postgres
executeTime	Long	执行时间	1667354445000
threadId	String	线程id	6952
accountName	String	执行操作的账号名称	test

请求示例

/v1/collector/sql-log-records?pageSize=10&pageNum-11-01 00:00:00&endTime=2022-11-29 23:59:59&prodInstId=10

请求体body

响应示例

{
  "message": "SUCCESS",
  "returnObj": {
    "list": [
      {
        "accountName": "test",
        "dbName": "postgres",
        "executeTime": 1667354445000,
        "hostAddress": "192.168.0.18:50744",
        "sqlText": "terminating connection due to administrator command",
        "threadId": "6952"
      }
    ],
    "pageNum": 1,
    "pageSize": 10,
    "pageTotal": 1,
    "total": 1
  },
  "statusCode": 800
}

错误码

访问ErrorCodes说明文档查看更多错误码。

关系数据库PostgreSQL版

查询实例的SQL洞察（SQL审计）日志