调用DescribeAuditLogRecords接口查看AnalyticDB MySQL集群的SQL审计日志。

使用说明

调用本接口查看AnalyticDB MySQL集群的SQL审计日志前,需要开启SQL审计。您可以调用DescribeAuditLogConfig接口查询SQL审计的开启状态,如未开启,可调用ModifyAuditLogConfig接口开启SQL审计。

仅当SQL审计状态为开启时,才能查询到SQL审计日志,且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计,再次打开时,仅能查询到再次打开后的SQL审计日志。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAuditLogRecords

系统规定参数,取值:DescribeAuditLogRecords

DBClusterId String am-bp1jj9xqft1po****

集群ID。

说明 您可以调用DescribeDBClusters查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
EndTime String 2022-01-23T22:18Z

查询结束时间,UTC时间,格式为:yyyy-MM-ddTHH:mmZ。

说明
  • 查询结束时间需晚于查询开始时间。
  • 查询开始时间与查询结束时间的间隔不能超过24小时。
RegionId String cn-hangzhou

地域ID。

说明 您可通过调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息,包括地域ID。
StartTime String 2022-01-23T02:18Z

查询开始时间,UTC时间,格式为:yyyy-MM-ddTHH:mmZ。

说明 仅当SQL审计状态为开启时,才能查询到SQL审计日志,且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计,再次打开时,仅能查询到再次打开后的SQL审计日志。
DBName String adb_demo

执行SQL的数据库名称。

QueryKeyword String adb

对查询包含目标关键字的SQL进行查询。

SqlType String SELECT

SQL类型,取值说明:

  • DELETE
  • DROP
  • SELECT
  • INSERT
  • UPDATE
  • ALTER
  • INSERT_INTO_SELECT
说明 每次允许传入一种类型查询,若该参数为空,默认查询SELECT类型。
Succeed String true

目标SQL是否执行成功,取值说明:

  • true:执行成功。
  • false:执行失败。
HostAddress String 100.104.XX.XX:43908

执行目标SQL的客户端IP地址和端口号。

OrderType String asc

按SQL执行时间进行正序或倒序排序,取值说明:

  • asc:按时间正序。
  • desc:按时间倒序。
User String test

执行目标SQL的用户名。

Order String [{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]

根据指定字段进行排序,格式为JSON,是一个有序JSON数组,按输入数组的顺序进行复合排序,包含Field和Type两个字段。

  • Field表示需要排序的字段名,取值说明:
    • HostAddress:连接数据库的客户端地址。
    • Succeed:目标SQL是否执行成功。
    • TotalTime:目标SQL的执行总耗时。
    • DBName:执行目标SQL的数据库名称。
    • SQLType:SQL类型。
    • User:执行目标SQL的用户名。
    • ExecuteTime:目标SQL的执行开始时间。
  • Type表示排序类型,取值说明:
    • Desc:降序。
    • Asc:升序。
PageSize Integer 10

每页记录数,取值:

  • 10
  • 30
  • 50
  • 100

默认值:10。

PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值。默认值:1。

返回数据

名称 类型 示例值 描述
DBClusterId String am-bp1jj9xqft1po****

集群ID。

Items Array of SlowLogRecord

SQL审计日志列表。

ConnId String

此参数无效。

DBName String adb_demo

执行目标SQL的数据库名称。

ExecuteTime String 2022-01-23 16:05:08

目标SQL的执行开始时间,本地时间,格式为:yyyy-MM-dd HH:mm:ss。

HostAddress String 100.104.XX.XX:43908

执行目标SQL的客户端IP地址和端口号。

ProcessID String 2022012316100917201616624903453108504

任务ID。

SQLText String SELECT * FROM tb_courses

SQL语句详情。

SQLType String SELECT

目标SQL类型。

Succeed String true

目标SQL是否执行成功:

  • true:执行成功。
  • false:执行失败。
TotalTime String 20

目标SQL的执行时长,单位:毫秒(ms)。

User String test

执行目标SQL的用户名。

PageNumber String 1

页码。

PageSize String 30

每页记录数。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

TotalCount String 300

总记录数。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeAuditLogRecords
&DBClusterId=am-bp1jj9xqft1po****
&EndTime=2022-01-23T22:18Z
&RegionId=cn-hangzhou
&StartTime=2022-01-23T02:18Z
&<公共请求参数>

正常返回示例

XML格式

<TotalCount>300</TotalCount>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageSize>30</PageSize>
<PageNumber>1</PageNumber>
<DBClusterId>am-bp1jj9xqft1po****</DBClusterId>
<Items>
    <User>test</User>
    <ConnId>无</ConnId>
    <ExecuteTime>2022-01-23 16:05:08</ExecuteTime>
    <TotalTime>20</TotalTime>
    <DBName>adb_demo</DBName>
    <ProcessID>2022012316100917201616624903453108504</ProcessID>
    <SQLType>SELECT</SQLType>
    <HostAddress>100.104.XXX.XXX:43908</HostAddress>
    <SQLText>SELECT * FROM tb_courses</SQLText>
    <Succeed>true</Succeed>
</Items>

JSON格式

{
    "TotalCount": 300,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageSize": 30,
    "PageNumber": 1,
    "DBClusterId": "am-bp1jj9xqft1po****",
    "Items": {
        "User": "test",
        "ConnId": "无",
        "ExecuteTime": "2022-01-23 16:05:08",
        "TotalTime": 20,
        "DBName": "adb_demo",
        "ProcessID": 2.022012316100917e+36,
        "SQLType": "SELECT",
        "HostAddress": "100.104.XX.XX:43908",
        "SQLText": "SELECT * FROM tb_courses",
        "Succeed": true
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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