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

使用说明

调用DescribeAuditLogRecords接口,请确认已开启SQL审计。调用DescribeAuditLogConfig接口可以查询SQL审计的开启状态,如未开启,可调用ModifyAuditLogConfig接口开启SQL审计。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
DBClusterId String am-t4nj8619bz2w3****

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
RegionId String cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息,包括地域ID。
StartTime String 2021-12-08T09:53Z

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

说明 仅当SQL审计状态为开启时,才能查询到SQL审计日志,且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计,再次打开时,仅能查询到再次打开后的SQL审计日志。
EndTime String 2021-12-09T09:53Z

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

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

执行SQL的数据库名称。

QueryKeyword String adb

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

SqlType String SELECT

SQL类型,取值:

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

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

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

执行目标SQL的客户端IP地址和端口号,格式为:IP地址:端口号

OrderType String asc

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

  • asc:正序。
  • desc:倒序。
User String test_user

执行目标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

Action String DescribeAuditLogRecords

系统规定参数。取值:DescribeAuditLogRecords

返回数据

名称 类型 示例值 描述
TotalCount String 1

总记录数。

PageSize String 10

每页记录数。

RequestId String 8A564B7F-8C00-43C0-8EC5-919FBB70573

请求ID。

PageNumber String 1

页码。

DBClusterId String am-t4nj8619bz2w3****

集群ID。

Items Array of SlowLogRecord

SQL审计日志详情。

HostAddress String 100.104.XXX.XXX:43908

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

Succeed String true

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

  • true:执行成功。
  • false:执行失败。
SQLText String SELECT * FROM tb_courses

SQL语句详情。

TotalTime String 216

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

ConnId String

此参数不生效。

DBName String adb_test

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

SQLType String SELECT

目标SQL的类型。

ExecuteTime String 2021-12-08 20:52:02

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

ProcessID String 202106081752021720161662490345362390

任务ID。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeAuditLogRecords
&DBClusterId=am-t4nj8619bz2w3****
&RegionId=cn-hangzhou
&StartTime=2021-12-08T09:53Z
&EndTime=2021-12-09T09:53Z
&DBName=adb_demo
&QueryKeyword=adb
&SqlType=SELECT
&Succeed=true
&HostAddress=100.104.XXX.XXX:43908
&OrderType=asc
&User=test_user
&Order=[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]
&PageSize=10
&PageNumber=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAuditLogRecordsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>8A564B7F-8C00-43C0-8EC5-919FBB70573</RequestId>
    <PageNumber>1</PageNumber>
    <DBClusterId>am-t4nj8619bz2w3****</DBClusterId>
    <Items>
        <HostAddress>100.104.XXX.XXX:43908</HostAddress>
        <Succeed>true</Succeed>
        <SQLText>SELECT * FROM tb_courses</SQLText>
        <TotalTime>216</TotalTime>
        <ConnId>无</ConnId>
        <DBName>adb_test</DBName>
        <SQLType>SELECT</SQLType>
        <ExecuteTime>2021-12-08 20:52:02</ExecuteTime>
        <ProcessID>202106081752021720161662490345362390</ProcessID>
    </Items>
</DescribeAuditLogRecordsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "8A564B7F-8C00-43C0-8EC5-919FBB70573",
  "PageNumber" : 1,
  "DBClusterId" : "am-t4nj8619bz2w3****",
  "Items" : {
    "HostAddress" : "100.104.XXX.XXX:43908",
    "Succeed" : true,
    "SQLText" : "SELECT * FROM tb_courses",
    "TotalTime" : 216,
    "ConnId" : "无",
    "DBName" : "adb_test",
    "SQLType" : "SELECT",
    "ExecuteTime" : "2021-12-08 20:52:02",
    "ProcessID" : 2.0210608175202173E35
  }
}

错误码

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

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