全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeSQLLogs - 获取SQL执行记录

    文档中心

    云原生数据仓库AnalyticDB：DescribeSQLLogs - 获取SQL执行记录

    更新时间：Dec 20, 2024

    查询SQL执行记录。

    接口说明

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    gpdb:DescribeSQLLogsget
    *DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DBInstanceIdstring是

    实例 ID。

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

    SQL 关键字。

    		select 1
    StartTimestring是

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

    		2021-03-10T06:30Z
    Databasestring否

    数据库名称。

    		adbpgadmin
    Userstring否

    用户名。

    		testadmin
    EndTimestring是

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

    说明 查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过七天。
    		2021-03-17T06:30Z
    PageSizeinteger否

    每页记录数，取值说明：

    • 30
    • 50
    • 100

    默认值：30。

    		30
    PageNumberinteger否

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

    		1
    ExecuteCoststring否

    执行耗时，单位为秒（s）。

    		1
    SourceIPstring否

    来源 IP。

    		100.**.**.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

    返回参数

    名称类型描述示例值
    object
    PageRecordCountinteger

    每页包含的记录个数。

    		1
    RequestIdstring

    请求 ID。

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

    查询结果页数。

    		1
    Itemsarray<object>

    结果列表。

    Itemobject
    OperationClassstring

    操作类别。

    		DQL
    ExecuteStatestring

    执行状态。

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

    执行耗时。

    		2
    SQLTextstring

    SQL 语句内容。

    		select 1
    SourcePortinteger

    来源端口。

    		50514
    DBRolestring

    数据库角色。

    		master
    OperationTypestring

    执行 SQL 的类型。

    		SELECT
    SourceIPstring

    来源 IP。

    		100.**.**.90
    SQLPlanstring

    SQL 执行计划。

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史