调用DescribeSQLLogRecords接口查询实例的SQL洞察(SQL审计)日志。
支持的实例版本如下:
- MySQL
- SQL Server
- PostgreSQL
说明
- 本API无论调用成功或失败,单用户(主账号包括RAM账号)每分钟最多调用1000次。
- 本API不支持查询MySQL实例SQL洞察试用版的SQL洞察日志。
- 本API生成审计文件时(请求参数Form取值为File),最多记录100万条日志。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSQLLogRecords | 系统规定参数。取值:DescribeSQLLogRecords。 |
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxx | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx | 实例ID。 |
SQLId | Long | 否 | 25623548 | SQL语句唯一标识ID。 |
QueryKeywords | String | 否 | table_name | 用于查询的关键字。
说明 输入关键字后,系统会以Database、User和QueryKeywords同时进行关键字匹配,三个请求参数之间的逻辑关系为or。 |
StartTime | String | 是 | 2011-06-01T15:00:00Z | 查询开始时间,可查询当前日期前30天内的数据。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
Database | String | 否 | Database | 数据库名称。默认为所有数据库,也可以输入数据库名称查询,一次只能输入一个。 |
User | String | 否 | user | 用户名称。默认为所有用户,也可以输入用户名称查询,一次只能输入一个。 |
Form | String | 否 | Stream | 触发审计文件的生成或者返回SQL记录列表,取值:
说明 取值为File时,只支持MySQL(本地盘)和SQL Server实例,且最多记录100万条日志。 |
EndTime | String | 是 | 2011-06-11T15:00:00Z | 查询结束时间,大于查询开始时间,与查询开始时间间隔小于30天。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
PageSize | Integer | 否 | 30 | 每页记录数,取值:30~100。默认值:30。 |
PageNumber | Integer | 否 | 1 | 页码,取值:大于0且不超过Integer的最大值。 默认值:1。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 08A3B71B-FE08-4B03-974F-CC7EA6DB1828 | 请求ID。 |
PageNumber | Integer | 1 | 页码。 |
PageRecordCount | Integer | 30 | 本页SQL审计日志个数。 |
TotalRecordCount | Long | 100 | 总记录数。 |
Items | Array of SQLRecord | SQL审计日志列表。 |
|
SQLRecord | |||
HostAddress | String | 192.168.0.121 | 连接数据库的客户端IP地址。 |
SQLText | String | update test.zxb set id=0 limit 1 | SQL语句。 |
ReturnRowCounts | Long | 30 | 返回记录数。 |
DBName | String | testDB | 数据库名称。 |
ExecuteTime | String | 2011-06-11T15:00:23Z | 执行时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
ThreadID | String | 1025865428 | 线程ID。 |
TotalExecutionTimes | Long | 600 | 执行耗时,单位:微秒。 |
AccountName | String | accounttest | 执行操作的账号名称。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeSQLLogRecords
&DBInstanceId=rm-uf6wjk5xxxxxx
&StartTime=2011-06-01T15:00:00Z
&EndTime=2011-06-11T15:00:00Z
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<DescribeSQLLogRecordsResponse>
<PageNumber>1</PageNumber>
<TotalRecordCounts>1</TotalRecordCounts>
<ItemsCounts>1</ItemsCounts>
<SQLItems>
<SQLItem>
<DBName>test</DBName>
<AccountName>accounttest</AccountName>
<HostAddress>192.168.0.121</HostAddress>
<SQLText>update test.zxb set id=0 limit 1</SQLText>
<TotalExecutionTimes>12</TotalExecutionTimes>
<ReturnRowCounts>34</ReturnRowCounts>
<ExecuteTime>2011-06-11T15:00:23Z</ExecuteTime>
</SQLItem>
</SQLItems>
<RequestId>08A3B71B-FE08-4B03-974F-CC7EA6DB1828</RequestId>
</DescribeSQLLogRecordsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageNumber" : 1,
"TotalRecordCounts" : 1,
"ItemsCounts" : 1,
"SQLItems" : {
"SQLItem" : [ {
"DBName" : "test",
"AccountName" : "accounttest",
"HostAddress" : "192.168.0.121",
"SQLText" : "update test.zxb set id=0 limit 1",
"TotalExecutionTimes" : 12,
"ReturnRowCounts" : 34,
"ExecuteTime" : "2011-06-11T15:00:23Z"
} ]
},
"RequestId" : "08A3B71B-FE08-4B03-974F-CC7EA6DB1828"
}
错误码
访问错误中心查看更多错误码。