首页 云数据库 RDS API参考 API目录 日志 DescribeSQLLogRecords - 查询实例的SQL审计日志

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

调用DescribeSQLLogRecords接口查询实例的SQL洞察(SQL审计)日志。

接口说明

支持的实例版本如下:

  • MySQL
  • SQL Server
  • PostgreSQL
说明
  • 本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
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag

    请求参数

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

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

    ETnLKlblzczshOTUbOCzxxxxxxx
    DBInstanceIdstring

    实例ID。

    rm-uf6wjk5xxxxxxx
    SQLIdlong

    SQL语句唯一标识ID。

    25623548
    QueryKeywordsstring

    用于查询的关键字。

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

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

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

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

    查询开始时间,可查询当前日期前30天内的数据。格式: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

    查询结束时间,大于查询开始时间,与查询开始时间间隔小于30天。格式: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.0.121
    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.0.121",
            "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"
          }
        ]
      }
    }

    错误码

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

    阿里云首页 关系型数据库 相关技术圈