调用DescribeSQLLogs接口查询指定时间段的SQL执行记录。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSQLLogs

系统规定参数。取值:DescribeSQLLogs

DBInstanceId String gp-xxxxxxxx

实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL版实例的详情,包括实例ID。
QueryKeywords String select 1

SQL关键字。

StartTime String 2021-03-10T06:30Z

查询开始时间。格式为YYYY-MM-DDThh:mmZ(UTC时间)。

Database String adbpgadmin

数据库名称。

User String testadmin

用户名。

EndTime String 2021-03-17T06:30Z

查询结束时间。格式为YYYY-MM-DDThh:mmZ(UTC时间)。

说明 查询结束时间需晚于开始时间,且开始时间和结束时间的时间间隔不能超过七天。
PageSize Integer 1

返回的页数。

PageNumber Integer 10

每页记录条数。

ExecuteCost String 1

执行耗时,单位为秒(s)。

SourceIP String 100.**.**.90

来源IP。

ExecuteState String success

执行状态。取值如下:

  • success:成功
  • fail:失败
OperationClass String DQL

操作类别,取值如下:

  • DQL
  • DML
  • DDL
  • DCL
  • TCL
OperationType String SELECT

执行SQL的类型。

说明
  • 如果设置了OperationClass参数,则OperationType的值必须属于对应的语言类型。例如OperationClass的值为DQL,则OperationType的值必须为DQL类型的SQL,例如SELECT
  • 如果没有设置OperationClass参数,则OperationType的值可以是任意类型SQL。
  • 如果没有设置OperationClass参数也没有设置OperationType参数,则表示返回所有类型SQL。
MaxExecuteCost String 1000

慢SQL最大耗时,取值需大于等于0,单位为秒(s)。

MinExecuteCost String 1

慢SQL最小耗时,取值需大于等于0,单位为秒(s)。

返回数据

名称 类型 示例值 描述
PageRecordCount Integer 1

每页包含的记录个数。

RequestId String A7941C94-B92F-46A0-BD3E-2D**********

请求ID。

PageNumber Integer 1

查询结果页数。

Items Array of Item

结果列表。

OperationClass String DQL

操作类别。

ExecuteState String success

执行状态。

  • success:成功
  • fail:失败
ExecuteCost Float 2

执行耗时。

SQLText String select 1

SQL语句内容。

SourcePort Integer 50514

来源端口。

DBRole String master

数据库角色。

OperationType String SELECT

执行SQL的类型。

SourceIP String 100.**.**.90

来源IP。

SQLPlan String ""

SQL执行计划。

ReturnRowCounts Long 1

执行结果返回的行数。

DBName String adbpgadmin

数据库名称。

OperationExecuteTime String 2021-03-15T17:02:32Z

执行时间。

ScanRowCounts Long 1

扫描行数。

AccountName String testadmin

执行SQL的数据库账号。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=DescribeSQLLogs
&DBInstanceId=gp-xxxxxxxx
&EndTime=2021-03-17T06:30Z
&StartTime=2021-03-10T06:30Z
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  } ]
}

错误码

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