ListSQLExecAuditLog - 获取SQL审计日志列表

获取在DMS进行SQL操作的审计日志列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
StartTimestring

开始操作的时间。

说明 开始时间可模糊输入,时间格式为 YYYY-MM-DD hh:mm:ss。
2021-11-08 11:04:00
EndTimestring

结束操作的时间。

说明 结束时间可模糊输入,时间格式为 YYYY-MM-DD hh:mm:ss,建议您输入的开始时间和结束时间间隔不要超过一天,方便分页拉取,提升效率。
2021-11-08 11:00:00
SearchNamestring

搜索名称。

说明 此处的搜索名称可输入数据库名,如果是实例级别的 SQL 操作,则可输入实例名称。
test_SearchName
OpUserNamestring

操作人昵称。

test_OpUserName
SqlTypestring

SQL 类型,常见 SQL 类型取值说明如下:

  • SELECT:查询
  • INSERT:插入
  • DELETE:删除
  • CREATE_TABLE:创建表
说明 您可以在控制台页面上方操作审计->SQL 类型中查看更多 SQL 类型取值。
SELECT
ExecStatestring

执行状态,取值说明如下:

  • -1:执行失败
  • 0:暂未执行
  • 2:执行中
  • -2:取消执行
  • 1:执行成功
1
PageSizeinteger

每页数据量。最大值不超过 100。

20
PageNumberinteger

开始页码。请输入合理的页码,若页码填写超过日志总页数,可能会操作总记录数不为 0,但是操作审计日志列表信息为空的情况。

1
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

3***

返回参数

名称类型描述示例值
object
TotalCountlong

操作总记录数。

1
RequestIdstring

请求 ID。

39BC9C86-95AE-58F2-9862-A7C3D896****
ErrorCodestring

错误码。

MissingStartTime
ErrorMessagestring

错误信息。

StartTime is mandatory for this action.
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
SQLExecAuditLogListarray<object>

SQL 操作审计列表。

SQLExecAuditLogobject

SQL 操作审计信息。

OpTimestring

操作时间。

2021-11-08 11:04:27
UserNamestring

操作人昵称。

test_UserName
UserIdlong

操作人 ID。

12****
InstanceNamestring

数据库名称。

说明 如果此处为实例级别的操作,则返回实例名称。
polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】
InstanceIdlong

实例 ID。

185***
SchemaNamestring

数据库名称。

polar123
DbIdlong

数据库 ID。

2157****
Logicboolean

是否为逻辑库,返回值说明如下:

  • true:逻辑库
  • false:物理库
false
SQLTypestring

SQL 类型,常见 SQL 类型返回值说明如下:

  • SELECT:查询
  • INSERT:插入
  • DELETE:删除
  • CREATE_TABLE:创建表
说明 您可以在控制台页面上方操作审计->SQL 类型中查看更多 SQL 类型返回值。
SELECT
SQLstring

已执行的 SQL 语句。

SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC
ExecStatestring

执行状态,返回值说明如下:

  • FAIL:执行失败
  • NOEXE:暂未执行
  • RUNNING:执行中
  • CANCEL:取消执行
  • SUCCESS:执行成功
SUCCESS
AffectRowslong

表示执行 SQL 语句后返回的总行数。比如,SQL 语句为查询语句,此参数返回的是查询数据的总行数。

2
ElapsedTimelong

操作耗时,单位为毫秒。

18
Remarkstring

备注信息。

success

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "39BC9C86-95AE-58F2-9862-A7C3D896****",
  "ErrorCode": "MissingStartTime",
  "ErrorMessage": "StartTime is mandatory for this action.",
  "Success": true,
  "SQLExecAuditLogList": {
    "SQLExecAuditLog": [
      {
        "OpTime": "2021-11-08 11:04:27",
        "UserName": "test_UserName",
        "UserId": 0,
        "InstanceName": "polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】",
        "InstanceId": 0,
        "SchemaName": "polar123",
        "DbId": 0,
        "Logic": false,
        "SQLType": "SELECT",
        "SQL": "SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC",
        "ExecState": "SUCCESS",
        "AffectRows": 2,
        "ElapsedTime": 18,
        "Remark": "success"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-23API 内部配置变更,不影响调用查看变更详情