调用ListSQLExecAuditLog获取SQL窗口列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListSQLExecAuditLog |
系统规定参数。取值:ListSQLExecAuditLog。 |
| StartTime | String | 是 | 2021-11-08 11:04:00 |
开始操作的时间。 说明 开始时间可模糊输入,时间格式为YYYY-MM-DD hh:mm:ss。
|
| EndTime | String | 是 | 2021-11-08 11:00:00 |
结束操作的时间。 说明 结束时间可模糊输入,时间格式为YYYY-MM-DD hh:mm:ss,建议您输入的开始时间和结束时间间隔不要超过一天,方便分页拉取,提升效率。
|
| SearchName | String | 否 | test_SearchName |
搜索名称。 说明 此处的搜索名称可输入数据库名,如果是实例级别的SQL操作,则可输入实例名称。
|
| OpUserName | String | 否 | test_OpUserName |
操作人昵称。 |
| SqlType | String | 否 | SELECT |
SQL类型,常见SQL类型取值说明如下:
说明 您可以在控制台页面上方操作审计->SQL类型中查看更多SQL类型取值。
|
| ExecState | String | 否 | SUCCESS |
执行状态,取值说明如下:
|
| PageSize | Integer | 是 | 20 |
每页数据量。最大值不超过100。 |
| PageNumber | Integer | 是 | 1 |
开始页码。 |
| Tid | Long | 否 | 3*** |
租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。 |
| RegionId | String | 否 | cn-hangzhou |
DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TotalCount | Long | 1 |
操作总记录数。 |
| RequestId | String | 39BC9C86-95AE-58F2-9862-A7C3D896**** |
请求ID。 |
| ErrorCode | String | MissingStartTime |
错误码。 |
| ErrorMessage | String | StartTime is mandatory for this action. |
错误信息。 |
| Success | Boolean | true |
请求是否成功,返回值如下:
|
| SQLExecAuditLogList | Array of SQLExecAuditLog |
SQL操作审计列表。 |
|
| SQLExecAuditLog | |||
| OpTime | String | 2021-11-08 11:04:27 |
操作时间。 |
| UserName | String | test_UserName |
操作人昵称。 |
| UserId | Long | 12**** |
操作人ID。 |
| InstanceName | String | polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】 |
数据库名称。 说明 如果此处为实例级别的操作,则返回实例名称。
|
| InstanceId | Long | 185*** |
实例ID。 |
| SchemaName | String | polar123 |
数据库名称。 |
| DbId | Long | 2157**** |
数据库ID。 |
| Logic | Boolean | false |
是否为逻辑库,返回值说明如下:
|
| SQLType | String | SELECT |
SQL类型,常见SQL类型返回值说明如下:
说明 您可以在控制台页面上方操作审计->SQL类型中查看更多SQL类型返回值。
|
| SQL | String | SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC |
已执行的SQL语句。 |
| ExecState | String | SUCCESS |
执行状态,返回值说明如下:
|
| AffectRows | Long | 2 |
表示执行SQL语句后返回的总行数。比如,SQL语句为查询语句,此参数返回的是查询数据的总行数。 |
| ElapsedTime | Long | 18 |
操作耗时,单位为毫秒。 |
| Remark | String | success |
备注信息。 |
示例
请求示例
http(s)://dms-enterprise.aliyuncs.com/?Action=ListSQLExecAuditLog
&StartTime=2021-11-08 11:04:00
&EndTime=2021-11-08 11:00:00
&SearchName=test_SearchName
&OpUserName=test_OpUserName
&SqlType=SELECT
&ExecState=SUCCESS
&PageSize=20
&PageNumber=1
&Tid=3***
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListSQLExecAuditLogResponse>
<TotalCount>1</TotalCount>
<RequestId>39BC****-95AE-58F2-9862-A7C3D896****</RequestId>
<Success>true</Success>
<SQLExecAuditLogList>
<SQLExecAuditLog>
<UserName>test_UserName</UserName>
<InstanceId>185****</InstanceId>
<ElapsedTime>18</ElapsedTime>
<ExecState>SUCCESS</ExecState>
<OpTime>2021-11-08 11:04:27</OpTime>
<SQL>SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC</SQL>
<Remark/>
<InstanceName>polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】</InstanceName>
<UserId>12****</UserId>
<DbId>2157****</DbId>
<Logic>false</Logic>
<SQLType>SELECT</SQLType>
<SchemaName>polar123</SchemaName>
<AffectRows>2</AffectRows>
</SQLExecAuditLog>
</SQLExecAuditLogList>
</ListSQLExecAuditLogResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"RequestId" : "39BC9C86-95AE-58F2-9862-A7C3D896****",
"Success" : true,
"SQLExecAuditLogList" : {
"SQLExecAuditLog" : [ {
"UserName" : "test_UserName",
"InstanceId" : "185****",
"ElapsedTime" : 18,
"ExecState" : "SUCCESS",
"OpTime" : "2021-11-08 11:04:27",
"SQL" : "SELECT * FROM `polar123`.`p_qw` ORDER BY `id` DESC",
"Remark" : "",
"InstanceName" : "polar123@pc-bp1h9tgq4st9g****.mysql.polardb.rds.aliyuncs.com:3306【polar_qw_测试】",
"UserId" : "12****",
"DbId" : "2157****",
"Logic" : false,
"SQLType" : "SELECT",
"SchemaName" : "polar123",
"AffectRows" : 2
} ]
}
}
错误码
访问错误中心查看更多错误码。