文档

DescribeSQLLogRecords - 查询实例的SQL审计日志

更新时间:

该接口用于查询RDS实例的SQL洞察(SQL审计)日志。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

注意事项

  • 本 API 无论调用成功或失败,单用户(主账号包括 RAM 账号)每分钟最多调用 1000 次。
  • 本 API 不支持查询 MySQL 实例 SQL 洞察试用版的 SQL 洞察日志。
  • 本 API 生成审计文件时(请求参数 Form 取值为 File),最多记录 100 万条日志,且不支持通过关键字筛选日志。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeSQLLogRecordsREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
SQLIdlong

SQL 语句唯一标识 ID。

25623548
QueryKeywordsstring

用于查询的关键字。

  • 通过 API 生成审计文件时(请求参数 Form 取值为 File),不支持通过关键字筛选。

  • 多个关键字以空格分隔,不超过 10 个关键字;各个关键字之间的逻辑关系为 and

  • 如果 SQL 语句中的字段名使用了反引号(`),以该字段名作为查询的关键字时,也需要输入反引号。例如,字段名为`id`,则输入`id`,而不是 id。

说明 输入关键字后,系统会以 DatabaseUserQueryKeywords 同时进行关键字匹配,三个请求参数之间的逻辑关系为 or
table_name
StartTimestring

查询开始时间,可查询当前日期前 15 天内的数据。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2011-06-01T15:00:00Z
Databasestring

数据库名称。默认为所有数据库,也可以输入数据库名称查询,一次只能输入一个。

Database
Userstring

用户名称。默认为所有用户,也可以输入用户名称查询,一次只能输入一个。

user
Formstring

触发审计文件的生成或者返回 SQL 记录列表,取值:

  • File:若传入这个值,则触发审计文件的生成,只返回公共参数,需再调用 DescribeSQLLogFiles 接口获取文件的最终下载地址。
  • Stream:默认值,返回 SQL 记录列表。
说明 取值为 File 时,只支持 MySQL(本地盘)和 SQL Server 实例,且最多记录 100 万条日志。
Stream
EndTimestring

查询结束时间,大于查询开始时间,与查询开始时间间隔小于等于 15 天。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2011-06-11T15:00:00Z
PageSizeinteger

每页记录数,取值:30~100。默认值:30

30
PageNumberinteger

页码,取值:大于 0 且不超过 Integer 的最大值。

默认值:1

1

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

08A3B71B-FE08-4B03-974F-CC7EA6DB1828
PageNumberinteger

页码。

1
PageRecordCountinteger

本页 SQL 审计日志个数。

30
TotalRecordCountlong

总记录数。

100
Itemsobject []

SQL 审计日志列表。

HostAddressstring

连接数据库的客户端 IP 地址。

192.168.XX.XX
SQLTextstring

SQL 语句。

update test.zxb set id=0 limit 1
ReturnRowCountslong

返回记录数。

30
DBNamestring

数据库名称。

testDB
ExecuteTimestring

执行时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2011-06-11T15:00:23Z
ThreadIDstring

线程 ID。

1025865428
TotalExecutionTimeslong

执行耗时,单位:微秒。

600
AccountNamestring

执行操作的账号名称。

accounttest

示例

正常返回示例

JSON格式

{
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "Items": {
    "SQLRecord": [
      {
        "HostAddress": "192.168.XX.XX",
        "SQLText": "update test.zxb set id=0 limit 1",
        "ReturnRowCounts": 30,
        "DBName": "testDB",
        "ExecuteTime": "2011-06-11T15:00:23Z",
        "ThreadID": "1025865428",
        "TotalExecutionTimes": 600,
        "AccountName": "accounttest"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈