文档

DescribeSQLLogsV2 - 查询SQL执行记录

更新时间:

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

接口说明

该接口不支持实例资源类型为存储预留模式的实例。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

该参数已废弃,无需传入该参数。

null
StartTimestring

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

2022-03-10T06:30Z
EndTimestring

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

说明 查询结束时间需晚于开始时间,且开始时间和结束时间的时间间隔不能超过 24 小时。
2022-03-17T06:30Z
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID。
cn-hangzhou
DBInstanceIdstring

实例 ID。

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

SQL 关键字。

select 1
Databasestring

数据库名称。

adbpgadmin
Userstring

用户名。

testadmin
ExecuteCoststring

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

1
SourceIPstring

来源 IP。

100.XX.XX.90
ExecuteStatestring

执行状态。取值如下:

  • 1:成功。
  • 0:失败。
1
OperationClassstring

操作类别,取值如下:

  • DQL
  • DML
  • DDL
  • DCL
  • TCL
DQL
OperationTypestring

执行 SQL 的类型。

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

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

    1000
    MinExecuteCoststring

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

    1
    PageNumberstring

    页码,大于 0 且不超过 Integer 的最大值,默认值:1。

    1
    PageSizestring

    每页记录数,取值说明:

    • 30(默认值)
    • 50
    • 100
    30

    返回参数

    名称类型描述示例值
    object
    PageRecordCountinteger

    每页包含的记录个数。

    1
    RequestIdstring

    请求 ID。

    A7941C94-B92F-46A0-BD3E-2D**********
    PageNumberinteger

    查询结果页数。

    1
    Itemsobject []

    结果列表。

    OperationClassstring

    操作类别。

    DQL
    ExecuteStatestring

    执行状态。

    • success:成功
    • fail:失败
    success
    ExecuteCostfloat

    执行耗时。

    2
    SQLTextstring

    SQL 语句内容。

    select 1
    SourcePortinteger

    来源端口。

    50514
    DBRolestring

    数据库角色。

    master
    OperationTypestring

    执行 SQL 的类型。

    SELECT
    SourceIPstring

    来源 IP。

    100.**.**.90
    ReturnRowCountslong

    执行结果返回的行数。

    1
    DBNamestring

    数据库名称。

    adbpgadmin
    OperationExecuteTimestring

    执行时间。

    2021-03-15T17:02:32Z
    ScanRowCountslong

    扫描行数。

    1
    AccountNamestring

    执行 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",
          "ReturnRowCounts": 1,
          "DBName": "adbpgadmin",
          "OperationExecuteTime": "2021-03-15T17:02:32Z",
          "ScanRowCounts": 1,
          "AccountName": "testadmin"
        }
      ]
    }

    错误码

    HTTP status code错误码错误信息
    400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

    变更历史

    变更时间变更内容概要操作
    2023-08-02OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    • 本页导读 (1)