DescribeAuditLogs - 查询审计告警日志-数据库自治服务(DAS)-阿里云帮助中心

本接口一般用于数据审计告警日志列表查询，便于告警搜索和告警处理。

接口说明

使用该接口需满足以下前提条件：

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型，默认为 zh_cn。取值： zh_cn：中文。 en_us：英文。	zh-CN
UserName	string	否	用户名	admin
ClientIp	string	否	请求客户端 IP。	11.26.118.7
ClientUa	string	否	客户端类型。	mysql
InstanceName	string	否	资产实例名称	rm-t4ni1cezz5y3xxxx
DatabaseName	string	否	数据库的名称。	TestDB
StartTime	integer	否	告警日志起始时间，单位为毫秒。	1608888296000
EndTime	integer	否	告警日志结束时间，以毫秒为单位的 unix 时间戳。	15682887991222
ProductCode	string	否	数据资产所属的产品名称。取值：RDS、PolarDB、PolarDB-X 2.0等。	RDS
ProductId	integer	否	数据对象所属的产品名称对应的 ID。取值： 3：ADB-MYSQL 5：RDS 7：PolarDB-X 8：PolarDB 9：ADB-PG 11：MongoDB 25：Redis	5
SqlText	string	否	SQL 语句内容。	SELECT * FROM test where name = 'das'
ExecuteTimeRange	string	否	执行时间的范围。	in[1000 2000]
EffectRowRange	string	否	影响行数范围。	in[1 33]
RuleID	string	否	审计规则 id。	9953411
RuleName	string	否	审计规则名称。	test_rule
OperateType	string	否	操作类型。	Insert
OssObjectKey	string	否	OSS 存储对象的 key 值。	N.A
AsyncRequestId	string	否	请求 id。	2c548e83-1473-4fda-b3dc-5a189074ead5
PageSize	integer	否	每页最大记录数，默认值为 10。	30
CurrentPage	integer	否	当前页数。	3
RuleCategory	string	否	规则类型。	10
LoadWhiteList	boolean	否	是否加载白名单状态。	false
IpType	string	否	网络类型。枚举类型，取值： default（默认值）：非阿里云服务 aliyun：阿里云服务	aliyun
LogSource	string	否	数据来源	SLOW_SQL
RuleAggQuery	boolean	否	是否聚合查询	true
RuleId	string	否	规则 ID	867028

返回参数

名称	类型	描述	示例值
	object
AsyncRequestId	string	请求 id。	3926fba5-1774-44f4-af2d-ac7b33e86c3b
CurrentPage	integer	当前页数。	1
PageSize	integer	分页查询，每页大小。	10
RequestId	string	请求 ID。	A7021857-AFD9-5AD6-979D-AA7DFC5AFADF
TotalCount	integer	总的记录数（仅 Redis 引擎有效）	12
Items	array<object>	SQL 日志记录中的客户端 IP SQL 日志记录中客户端的 IP 地址
	object	物理异步读。
CreationTime	integer	告警时间，单位为毫秒。	1536751124000
WarnLevel	string	危险等级。 1：低危。 2：中危。 3：高危。	1
ClientPort	string	查询中客户端端口号	53815
TableName	string	查询中使用的表名	it_table
EffectRow	integer	影响行数。	10
PackageName	string	MaxCompute 包名称。	test01
UserId	string	用户 UID。	19********94
Message	string	原始日志内容。	success
RuleId	string	审计规则 id。	9953411
OperateType	string	操作类型。	Drop
LogTime	integer	日志执行时间。	1751870592000
WarnLevelName	string	危险等级名称。低危。中危。高危。	1
InstanceName	string	实例别名。	test-instance-003
DatabaseName	string	数据库名称。	chngc_b2b_migration_sh
OssObjectKey	string	OSS 存储对象的 key 值。	N.A
ExecuteStatus	integer	执行状态：0：未成功 1：执行成功	1
ProductId	integer	数据对象所属的产品名称对应的 ID。取值： 3：ADB-MYSQL 5：RDS 7：PolarDB-X 8：PolarDB 9：ADB-PG 11：MongoDB 25：Redis	5
ExecuteTime	integer	执行时长，单位为毫秒。	1751870592000
UserName	string	用户名	admin
InstanceDescription	string	数据资产实例的描述信息。	instance dscription
RuleName	string	审计规则名称。	name
ColumnName	string	列名。	ds
ClientIp	string	查询中的客户端 IP 地址	100.104.16.251
ClientUa	string	客户端类型。	mysql
Id	integer	主键 ID。	1
ProductCode	string	数据资产所属的产品名称。取值：RDS、PolarDB、PolarDB-X 2.0 等。	RDS
SqlText	string	SQL 语句。	select * from test03
InWhiteList	boolean	告警是否在加白列表。	True
IpType	string	网络类型。枚举类型，取值： default（默认值）：非阿里云服务 aliyun：阿里云服务	aliyun
RuleCategory	string	规则类型。	10
LogSource	string	数据来源	SLOW_SQL
InstanceAuditStatus	string	实例审计状态	2

示例

正常返回示例

JSON格式

{
  "AsyncRequestId": "3926fba5-1774-44f4-af2d-ac7b33e86c3b",
  "CurrentPage": 1,
  "PageSize": 10,
  "RequestId": "A7021857-AFD9-5AD6-979D-AA7DFC5AFADF",
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "WarnLevel": "1",
      "ClientPort": "53815",
      "TableName": "it_table",
      "EffectRow": 10,
      "PackageName": "test01",
      "UserId": "19********94",
      "Message": "success",
      "RuleId": "9953411",
      "OperateType": "Drop",
      "LogTime": 1751870592000,
      "WarnLevelName": "1",
      "InstanceName": "test-instance-003",
      "DatabaseName": "chngc_b2b_migration_sh",
      "OssObjectKey": "N.A",
      "ExecuteStatus": 1,
      "ProductId": 5,
      "ExecuteTime": 1751870592000,
      "UserName": "admin",
      "InstanceDescription": "instance dscription",
      "RuleName": "name",
      "ColumnName": "ds",
      "ClientIp": "100.104.16.251",
      "ClientUa": "mysql",
      "Id": 1,
      "ProductCode": "RDS",
      "SqlText": "select * from test03",
      "InWhiteList": true,
      "IpType": "aliyun",
      "RuleCategory": "10",
      "LogSource": "SLOW_SQL",
      "InstanceAuditStatus": "2"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

更多信息，参考变更详情。