DescribeSQLLogs接口已废弃-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

查询SQL执行记录。

接口说明

说明

该接口已废弃，如需查询 SQL 执行记录，请参见 DescribeSQLLogsV2 。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:DescribeSQLLogs

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的实例 ID。	gp-xxxxxxxx
QueryKeywords	string	否	SQL 关键字。	select 1
StartTime	string	是	查询开始时间。格式为YYYY-MM-DDThh:mmZ（UTC 时间）。	2021-03-10T06:30Z
Database	string	否	数据库名称。	adbpgadmin
User	string	否	用户名。	testadmin
EndTime	string	是	查询结束时间。格式为YYYY-MM-DDThh:mmZ（UTC 时间）。说明查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过七天。	2021-03-17T06:30Z
PageSize	integer	否	每页记录数，取值说明： 30 50 100 默认值：30。	30
PageNumber	integer	否	页码，大于 0 且不超过 Integer 的最大值，默认值：1。	1
ExecuteCost	string	否	执行耗时，单位为秒（s）。	1
SourceIP	string	否	来源 IP。	100...90
ExecuteState	string	否	执行状态。取值如下： 1：成功。 0：失败。	1
OperationClass	string	否	操作类别，取值如下： DQL DML DDL DCL TCL	DQL
OperationType	string	否	执行 SQL 的类型。说明如果设置了 OperationClass 参数，则 OperationType 的值必须属于对应的语言类型。例如 OperationClass 的值为 DQL，则 OperationType 的值必须为 DQL 类型的 SQL，例如 SELECT。如果没有设置 OperationClass 参数，则 OperationType 的值可以是任意类型 SQL。如果没有设置 OperationClass 参数也没有设置 OperationType 参数，则表示返回所有类型 SQL。	SELECT
MaxExecuteCost	string	否	慢 SQL 最大耗时，取值需大于等于 0，单位为秒（s）。	1000
MinExecuteCost	string	否	慢 SQL 最小耗时，取值需大于等于 0，单位为秒（s）。	1

返回参数

名称	类型	描述	示例值
	object
PageRecordCount	integer	每页包含的记录个数。	1
RequestId	string	请求 ID。	A7941C94-B92F-46A0-BD3E-2D**********
PageNumber	integer	查询结果页数。	1
Items	array<object>	结果列表。
	object
OperationClass	string	操作类别。	DQL
ExecuteState	string	执行状态。 success：成功 fail：失败	success
ExecuteCost	number	执行耗时。	2
SQLText	string	SQL 语句内容。	select 1
SourcePort	integer	来源端口。	50514
DBRole	string	数据库角色。	master
OperationType	string	执行 SQL 的类型。	SELECT
SourceIP	string	来源 IP。	100...90
SQLPlan	string	SQL 执行计划。	""
ReturnRowCounts	integer	执行结果返回的行数。	1
DBName	string	数据库名称。	adbpgadmin
OperationExecuteTime	string	执行时间。	2021-03-15T17:02:32Z
ScanRowCounts	integer	扫描行数。	1
AccountName	string	执行 SQL 的数据库账号。	testadmin

示例

正常返回示例

JSON格式

{
  "PageRecordCount": 1,
  "RequestId": "A7941C94-B92F-46A0-BD3E-2D**********",
  "PageNumber": 1,
  "Items": [
    {
      "OperationClass": "DQL",
      "ExecuteState": "success",
      "ExecuteCost": 2,
      "SQLText": "select 1",
      "SourcePort": 50514,
      "DBRole": "master",
      "OperationType": "SELECT",
      "SourceIP": "100.**.**.90",
      "SQLPlan": "\"\"",
      "ReturnRowCounts": 1,
      "DBName": "adbpgadmin",
      "OperationExecuteTime": "2021-03-15T17:02:32Z",
      "ScanRowCounts": 1,
      "AccountName": "testadmin"
    }
  ]
}

错误码

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

变更历史

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