调用DescribeAuditLogRecords查询集群的SQL审计日志_云原生数据仓库AnalyticDB MySQL版-阿里云帮助中心

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

接口说明

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

仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。SQL审计日志不记录INSERT INTO VALUES、REPLACE INTO VALUES和UPSERT INTO VALUES操作。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeAuditLogRecords	Read	ADB acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	AnalyticDB MySQL数仓版（3.0）集群ID。说明您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL数仓版（3.0）集群的集群ID。	am-t4nj8619bz2w3****
RegionId	string	是	地域ID。说明您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。	cn-hangzhou
StartTime	string	是	查询开始时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。说明仅当SQL审计状态为开启时，才能查询到SQL审计日志，且只支持查询30天内的SQL审计日志。如果中途关闭了SQL审计，再次打开时，仅能查询到再次打开后的SQL审计日志。	2022-01-23T02:18Z
EndTime	string	是	查询结束时间，UTC时间，格式为：yyyy-MM-ddTHH:mmZ。说明查询结束时间需晚于查询开始时间。查询开始时间与查询结束时间的间隔不能超过24小时。	2022-01-23T22:18Z
DBName	string	否	执行SQL的数据库名称。	adb_demo
QueryKeyword	string	否	对查询包含目标关键字的SQL进行查询。	adb
SqlType	string	否	SQL类型，取值： DELETE SELECT UPDATE INSERT_INTO_SELECT ALTER DROP CREATE 说明每次仅允许传入一种类型查询，若该参数为空，默认查询SELECT类型。	SELECT
Succeed	string	否	目标SQL是否执行成功，取值说明： true：执行成功。 false：执行失败。	true
HostAddress	string	否	执行目标SQL的客户端IP地址和端口号。	100.104.XX.XX:43908
OrderType	string	否	按SQL执行时间进行正序或倒序排序，取值说明： asc：正序。 desc：倒序。	asc
User	string	否	执行目标SQL的用户名。	test_user
Order	string	否	根据指定字段进行排序，格式为JSON，是一个有序JSON数组，按输入数组的顺序进行复合排序，包含Field和Type两个字段。 Field表示需要排序的字段名，取值说明： HostAddress：连接数据库的客户端地址。 Succeed：目标SQL是否执行成功。 TotalTime：目标SQL的执行总耗时。 DBName：执行目标SQL的数据库名称。 SQLType：SQL类型。 User：执行目标SQL的用户名。 ExecuteTime：目标SQL的执行开始时间。 Type表示排序类型，取值说明： Desc：降序。 Asc：升序。	[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]
PageSize	integer	否	每页记录数，取值： 10 30 50 100 说明本参数不填写时，默认为10。	10
PageNumber	integer	否	页码，取值为大于0且不超过Integer数据类型的最大值。默认值为1。	1

返回参数

名称	类型	描述	示例值
	object	详情。
TotalCount	string	总记录数。	1
PageSize	string	每页记录数。	10
RequestId	string	请求ID。	8A564B7F-8C00-43C0-8EC5-919FBB70573
PageNumber	string	页码。	1
DBClusterId	string	集群ID。	am-t4nj8619bz2w3****
Items	object []	SQL审计日志详情。
HostAddress	string	执行目标SQL的客户端IP地址和端口号。	100.104.XX.XX:43908
Succeed	string	目标SQL是否执行成功。取值说明： true：执行成功。 false：执行失败。	true
SQLText	string	SQL语句详情。	SELECT * FROM tb_courses
TotalTime	string	目标SQL的执行时长，单位：毫秒（ms）。	216
ConnId	string	此参数无效。	无
DBName	string	执行目标SQL的数据库名称。	adb_test
SQLType	string	目标SQL的类型。	SELECT
ExecuteTime	string	目标SQL的执行开始时间，本地时间，格式为：yyyy-MM-dd HH:mm:ss。	2022-01-23 16:05:08
ProcessID	string	任务ID。	202106081752021720161662490345362390
User	string	执行目标SQL的用户名。	test_user

示例

正常返回示例

JSON格式

{
  "TotalCount": "1",
  "PageSize": "10",
  "RequestId": "8A564B7F-8C00-43C0-8EC5-919FBB70573",
  "PageNumber": "1",
  "DBClusterId": "am-t4nj8619bz2w3****",
  "Items": [
    {
      "HostAddress": "100.104.XX.XX:43908",
      "Succeed": "true",
      "SQLText": "SELECT * FROM tb_courses",
      "TotalTime": "216",
      "ConnId": "无",
      "DBName": "adb_test",
      "SQLType": "SELECT",
      "ExecuteTime": "2022-01-23 16:05:08",
      "ProcessID": "202106081752021720161662490345362390",
      "User": "test_user"
    }
  ]
}

错误码

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

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