GetSqlConsoleOperationLog - 查询SQL窗口操作日志-数据管理 DMS-阿里云帮助中心

查询SQL窗口操作日志

接口说明

请注意，调用该接口时，服务地址需与实例所在 region 一致，否则无法获取完整的 SQL 窗口操作日志。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetSqlConsoleOperationLog

get

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceId	integer	否	实例 ID。	1
Username	string	否	用户名。	user
Schema	string	否	数据库 Schema。	mysql
SqlType	string	否	SQL 语句类型。	SELECT
PageNumber	integer	是	当前页码，从 1 开始。	1
PageSize	integer	是	每页大小。最大值：100。	20
StartTime	string	是	日志开始时间。	2026-01-01 00:00:00
EndTime	string	是	日志结束时间。	2026-06-01 00:00:00

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	C0A813EB-4623-523A-8598-86390CB4****
Data	array<object>	返回结构体。
	object	返回结构体。
StartTime	string	日志开始时间。	2026-01-01 00:00:00
Schema	string	数据库 Schema。	mysql
Sql	string	SQL 语句。	SELECT * FROM user;
Success	boolean	语句是否执行成功。	true
AffectRows	integer	影响行数。	100
Cost	integer	执行时长。单位：毫秒。	10
Error	string	错误信息。	Access Denied
Username	string	用户名。	user
DatabaseSearchName	string	数据库搜索名。	mysql@xxx.com
SqlType	string	SQL 类型。	SELECT
ErrorCode	string	错误码。	400
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
Success	boolean	请求是否成功。	true
TotalCount	integer	日志总数。	100

示例

正常返回示例

JSON格式

{
  "RequestId": "C0A813EB-4623-523A-8598-86390CB4****",
  "Data": [
    {
      "StartTime": "2026-01-01 00:00:00",
      "Schema": "mysql",
      "Sql": "SELECT * FROM user;",
      "Success": true,
      "AffectRows": 100,
      "Cost": 10,
      "Error": "Access Denied",
      "Username": "user",
      "DatabaseSearchName": "mysql@xxx.com",
      "SqlType": "SELECT"
    }
  ],
  "ErrorCode": "400",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 100
}

错误码

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

变更历史

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