GetLogList - 查询审计日志列表_数据安全中心(DSC)-阿里云帮助中心

查询数据库审计到的日志列表。

接口说明

使用说明

本接口用于查询日志列表，查询日期应避免范围过大，大范围的查询日期影响查询效率，推荐按时间段来查询一天或一周的日志。查询日志列表的所有查询条件数最多支持 30 个。查询条件 SqlKey 支持多个关键字，多个关键字之间以空格分隔。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-dbaudit:GetLogList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	数据库审计实例的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。接口的参数说明，请参见 DescribeRegions 。注意调用 DescribeRegions 接口查询 D100 实例支持的地域时，公共参数的 Version（API 版本）必须取值2018-03-20。	cn-hangzhou
InstanceId	string	是	审计的实例 ID。您可以通过调用 DescribeInstances 接口获取实例 ID。接口的参数说明，请参见 DescribeInstances 。注意调用 DescribeInstances 接口查询 D100 实例列表时，公共参数的 Version（API 版本）必须取值2018-03-20。	dbaudit-cn-78v1gc****
DbId	integer	否	审计系统中配置的数据源 ID。您可以通过调用 ListDataSources 获取数据源 ID。	1
BeginDate	string	是	要查询日志的开始日期。格式：`yyyy-MM-dd HH:mm:ss`。	2019-06-06 00:00:00
EndDate	string	是	要查询日志的结束日期。格式：`yyyy-MM-dd HH:mm:ss`。	2019-06-06 23:59:59
PageNumber	integer	否	设置当前页的页码。默认值为 1。	1
PageSize	integer	否	设置每页显示日志列表的数量。默认值为 10，最大值为 100。	10
SqlId	string	否	要查询的日志 ID。	1907181552270011186
SqlKey	string	否	要查询的日志的关键字。支持表名、字段名、SQL 语句等。	select
SessionId	string	否	会话 ID。	3011610850021000000
TemplateId	string	否	SQL 语句的模板 ID。	1000****
IsSuccess	string	否	SQL 语句执行是否成功。取值： true：表示成功。 false：表示失败。	true
MinAffectRows	integer	否	执行 SQL 语句的最小影响行数。	10
MaxAffectRows	integer	否	执行 SQL 语句的最大影响行数。	1000
MinExecCostUS	integer	否	数据库服务器执行 SQL 语句响应的最少时间。单位：微秒。	100
MaxExecCostUS	integer	否	数据库服务器执行 SQL 语句响应的最多时间。单位：微秒。	20000
RuleName	string	否	SQL 语句命中的审计规则的名称。	自定义风险规则
ClientIpList	array	否	连接数据库的客户端的 IP 地址列表，该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。
	string	否	连接数据库的客户端的 IP 地址列表，该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。	192.168.XX.XX
DbUserList	array	否	连接数据库的账号的用户名列表，该参数中的 N 代表多个值的序号。
	string	否	连接数据库的账号的用户名列表，该参数中的 N 代表多个值的序号。	root
DbHostList	array	否	连接数据库的地址列表，该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。
	string	否	连接数据库的地址列表，该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。	192.168.XX.XX
RiskLevelList	array	否	SQL 语句命中规则的风险等级列表，该参数中的 N 代表多个值的序号。取值： 0：表示无风险。 1：表示低风险等级。 3：表示中风险等级。 5：表示高风险等级。
	string	否	SQL 语句命中规则的风险等级列表，该参数中的 N 代表多个值的序号。取值： 0：表示无风险。 1：表示低风险等级。 3：表示中风险等级。 5：表示高风险等级。	0
RuleTypeList	array	否	SQL 语句命中规则的规则类型列表，该参数中的 N 代表多个值的序号。取值： 2：语句规则。 3：注入攻击。 4：漏洞攻击。 5：操作规则。 6：访问规则。 7：口令攻击。
	string	否	SQL 语句命中规则的规则类型列表，该参数中的 N 代表多个值的序号。取值： 2：语句规则。 3：注入攻击。 4：漏洞攻击。 5：操作规则。 6：访问规则。 7：口令攻击。	5
SqlTypeList	array	否	SQL 语句的类型列表，该参数中的 N 代表多个值的序号。取值： 1：表示 CREATE 语句。 2：表示 SET 语句。 4：表示 INSERT 语句。 8：表示 SELECT 语句。 16：表示 UPDATE 语句。 32：表示 DELETE 语句。 64：表示 DROP 语句； 128：表示 ALTER 语句。
	string	否	SQL 语句的类型列表，该参数中的 N 代表多个值的序号。取值： 1：表示 CREATE 语句。 2：表示 SET 语句。 4：表示 INSERT 语句。 8：表示 SELECT 语句。 16：表示 UPDATE 语句。 32：表示 DELETE 语句。 64：表示 DROP 语句； 128：表示 ALTER 语句。	8
ClientProgramList	array	否	客户端连接数据库所使用的工具列表，该参数中的 N 代表多个值的序号。
	string	否	客户端连接数据库所使用的工具列表，该参数中的 N 代表多个值的序号。	navicat
Lang	string	否	请求和接收消息的语言类型。取值： zh（默认）：中文。 en：英文。	zh

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	1B217656-2267-4FBF-B26C-CDD201BDC3B8
BeginDate	string	要查询日志的开始日期。	2019-06-06 00:00:00
EndDate	string	要查询日志的结束日期。	2019-06-06 23:59:59
Incomplete	string	查询结果是否精确。取值： true：表示精确。 false：表示不精确。	true
PageNumber	integer	当前页的页码。	1
PageSize	integer	每页显示日志列表的数量。	10
TotalCount	integer	查询到的日志总数。	10000
Results	array<object>	查询到的日志列表。
Info	object
ClientPort	integer	连接数据库的客户端的端口号。	15629
ExecCostUS	integer	数据库服务器执行 SQL 语句响应的时间。单位：微秒。	1000
AppClientIp	string	应用客户端的 IP 地址。支持 IPv4、IPv6 两种协议类型。	8.8.XX.XX
SessionLogoutTime	string	会话退出时间。	2019-06-06 00:00:00
ClientOsUser	string	客户端系统的账号的用户名。	administrator
RuleId	integer	SQL 语句命中的审计规则 ID。	50****
SqlId	string	要查询的日志 ID。	1907181552270011186
SessionId	string	会话 ID。	3011610850021000000
SqlType	string	SQL 语句的类型。取值： 1：表示 CREATE 语句。 2：表示 SET 语句。 4：表示 INSERT 语句。 8：表示 SELECT 语句。 16：表示 UPDATE 语句。 32：表示 DELETE 语句。 64：表示 DROP 语句； 128：表示 ALTER 语句。	8
RiskLevel	integer	SQL 语句命中规则的风险等级。取值： 0：表示无风险。 1：表示低风险等级。 3：表示中风险等级。 5：表示高风险等级。	0
AppUsername	string	应用客户端的账号的用户名。	zhangsan
DbId	integer	审计系统中配置的数据源的 ID。	1
RuleType	integer	SQL 语句命中规则的规则类型。取值： 2：语句规则。 3：注入攻击。 4：漏洞攻击。 5：操作规则。 6：访问规则。 7：口令攻击。	5
RuleKeyId	integer	SQL 语句命中规则的规则主键 ID。	50****
AffectRows	integer	执行 SQL 语句的影响行数。	100
Schema	string	Schema 库名。	db_test
SessionLoginTime	string	会话登录时间。	2019-06-06 00:00:00
DbUser	string	连接数据库的账号的用户名。	root
ServerMac	string	数据库服务器的 MAC 地址。	00163E06****
DbServer	string	数据库服务器的 IP 地址。支持 IPv4、IPv6 两种协议类型。	192.168.XX.XX:3306
RuleName	string	SQL 语句命中的审计规则的名称。	自定义风险规则
SqlContent	string	SQL 语句的内容。	select * from ****
ResponseCode	string	SQL 语句执行结果。 0 表示执行成功，其他数值为数据库错误码。	0
InstName	string	连接数据库的实例的名称。	orcl
ClientProgram	string	客户端连接数据库所使用的工具。	navicat
CaptureTime	string	执行 SQL 语句的开始时间。	2019-06-06 00:00:00
ClientIp	string	连接数据库的客户端的 IP 地址。支持 IPv4、IPv6 两种协议类型。	192.168.XX.XX
ClientIpAlias	string	连接数据库的客户端 IP 别名	自定义IP别名
ClientMac	string	连接数据库的客户端的 MAC 地址。	00163E06****
TemplateId	string	SQL 语句的模板 ID。	1000****
FetchCostUS	integer	数据库服务器执行 SQL 语句所用的总时间，包含网络延迟的时间。单位：微秒。	2000
ResponseText	string	SQL 语句执行时返回的错误信息。	Table 'your_table' doesn't exist

示例

正常返回示例

JSON格式

{
  "RequestId": "1B217656-2267-4FBF-B26C-CDD201BDC3B8",
  "BeginDate": "2019-06-06 00:00:00",
  "EndDate": "2019-06-06 23:59:59",
  "Incomplete": "true",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10000,
  "Results": [
    {
      "ClientPort": 15629,
      "ExecCostUS": 1000,
      "AppClientIp": "8.8.XX.XX",
      "SessionLogoutTime": "2019-06-06 00:00:00",
      "ClientOsUser": "administrator",
      "RuleId": 0,
      "SqlId": "1907181552270011186",
      "SessionId": "3011610850021000000",
      "SqlType": "8",
      "RiskLevel": 0,
      "AppUsername": "zhangsan",
      "DbId": 1,
      "RuleType": 5,
      "RuleKeyId": 0,
      "AffectRows": 100,
      "Schema": "db_test",
      "SessionLoginTime": "2019-06-06 00:00:00",
      "DbUser": "root",
      "ServerMac": "00163E06****",
      "DbServer": "192.168.XX.XX:3306",
      "RuleName": "自定义风险规则",
      "SqlContent": "select * from ****",
      "ResponseCode": "0",
      "InstName": "orcl",
      "ClientProgram": "navicat",
      "CaptureTime": "2019-06-06 00:00:00",
      "ClientIp": "192.168.XX.XX",
      "ClientIpAlias": "自定义IP别名",
      "ClientMac": "00163E06****",
      "TemplateId": "1000****",
      "FetchCostUS": 2000,
      "ResponseText": "Table 'your_table' doesn't exist"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-16	OpenAPI 描述信息更新	查看变更详情