DescribeSqlLogRecords - (废弃)查询DAS企业版日志明细

调用DescribeSqlLogRecords接口,查询DAS企业版日志明细。

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:DescribeSqlLogRecords

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

数据库实例 ID。

pc-2ze8g2am97624****

NodeId

string

节点 ID。

  • 对于 RDS MySQL 和 PolarDB MySQL 版,该参数仅适用于集群版实例。若不传该参数,默认查询主节点日志明细。

  • 对于 PolarDB-X 2.0,该参数传入polarx_cn(计算节点)或polarx_dn(数据节点)。

pi-uf6k5f6g3912i****

Role

string

PolarDB-X 2.0 数据库实例节点的角色。

  • **polarx_cn **:计算节点。

  • **polarx_dn **:数据节点。

polarx_cn

Filters

array<object>

筛选条件列表。

object

筛选条件。

Key

string

过滤参数。

说明

支持的过滤参数及其取值请参考请求参数补充说明

keyWords

Value

string

过滤参数取值。

select

StartTime

integer

开始时间,格式为 Unix 时间戳,单位为毫秒。

1596177993000

EndTime

integer

结束时间,格式为 Unix 时间戳,单位为毫秒。

1608888296000

PageNo

integer

分页查询的页码,从 1 开始,默认为 1。

1

PageSize

integer

每页最大记录数,最大支持 100,默认值为 10。

10

Key 支持的参数和取值:

  • KeyWords:关键字,多个关键字间使用空格隔开。

  • LogicalOperator:关键字间的逻辑操作,取值为 and 或 or。

  • AccountName:用户名,可以传递多个的,用逗号分开,上限为 5。

  • dbName:数据库名称,可以传递多个的,用逗号分开,上限为 5。

  • HostAddress:客户端 IP 地址,可以传递多个的,用逗号分开,上限为 5。

  • MaxConsume:最大耗时,单位 us。

  • MinConsume:最小耗时,单位 us。

  • MaxScanRows:最大扫描行。

  • MinScanRows:最小扫描行。

  • SqlType:SQL 类型,取值 select、update、insert 或 delete。

  • State:执行结果,取值 0(成功)或 1(失败)。

  • ThreadId:线程 ID。

  • SortKey:排序列名称,取值 ScanRows(扫描行数)、UpdateRows(更新行数)、Consume(耗时)、ExecuteTime(执行时间)、ReturnRows(返回行数)、LockTime(锁等待时间)、Frows(PolarDB-X 2.0 计算节点的拉取行数)、Scnt(PolarDB-X 2.0 计算节点的 DN 请求数)、CpuTime(CPU 执行时间)、PhysicalRead(物理读)。

  • SortMethod:排序方式,取值 DESC(降序)、ASC(升序)。默认为 DESC。

  • TraceId:PolarDB-X 2.0 实例的跟踪 ID。

  • MinRows:最小更新行数。

  • MaxRows:最大更新行数。

  • MinScnt:PolarDB-X 2.0 计算节点(CN)的 DN 最小请求数。

  • MaxScnt:PolarDB-X 2.0 计算节点(CN)的 DN 最大请求数。

  • TrxId:事务 ID。

  • Fail:错误码。

  • SqlId:SQL ID。

  • JobId:通过异步任务 ID 进一步查询返回结果。

返回参数

名称

类型

描述

示例值

object

Code

string

返回的状态码。

200

Message

string

请求返回消息。

说明

请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。

Successful

RequestId

string

请求 ID。

F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE

Success

string

请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true

Data

object

返回数据。

StartTime

integer

开始时间,格式为 Unix 时间戳,单位为毫秒。

1596177993000

EndTime

integer

结束时间,格式为 Unix 时间戳,单位为毫秒。

1608888296000

TotalRecords

integer

总记录数。

1

Items

object

列表数据

SQLLogRecord

array<object>

SQL 日志数据。

object

SQL 日志数据。

Ext

string

扩展信息字段,备用参数。

None

ExecuteTime

string

执行时间,格式为 UTC 时间:yyyy-MM-ddTHH:mm:ssZ

2023-12-07T02:15:32Z

OriginTime

integer

执行时间戳,格式为 Unix 时间,单位为毫秒。

1701886532000

HostAddress

string

客户端 IP 地址。

11.197.XX.XX

UpdateRows

integer

更新行数。

0

LogicRead

integer

逻辑读。

0

SqlText

string

SQL 语句。

select resource_id as cluster_id, tpl_name \n\tfrom dbfree_alert_resource_tpl_ref\n\twhere user_id=? and type='cluster' group by resource_id, tpl_name

LockTime

integer

锁等待时间,单位毫秒。

0

ScanRows

integer

扫描行数。

0

ThreadId

integer

线程 ID。

None

State

string

执行状态。

  • 0:执行成功。

  • 1:执行失败。

0

DBName

string

数据库名称。

testdb

SqlType

string

SQL 语句的类型。

select

AccountName

string

数据库账号。

testname

PhysicSyncRead

integer

物理同步读。

0

PhysicAsyncRead

integer

物理异步读。

0

TrxId

string

事务 ID。

200000

ReturnRows

integer

返回行数。

0

Consume

integer

执行耗时(us)。

58

Vip

string

查询链接的 endpoint 解析地址。

100.115.XX.XX

NodeId

string

节点 ID。

pi-uf6k5f6g3912i****

SqlId

string

SQL ID。

c67649d4a7fb62c4f8c7a447c52b5b17

UseImciEngine

string

PolarDB MySQL 版实例是否使用列存索引。

  • true:是。

  • false:否。

true

ParallelQueueTime

string

PolarDB MySQL 版实例的并行度。

2

ParallelDegree

string

PolarDB MySQL 版实例的并行排队时间,单位为毫秒。

10

Scnt

integer

PolarDB-X 2.0 计算节点(CN)的 DN 请求数。

10

Rows

integer

PolarDB-X 2.0 数据库实例计算节点总更新或返回的行数。

10

Frows

integer

PolarDB-X 2.0 计算节点(CN)的拉取行数。

10

TraceId

string

PolarDB-X 2.0 的跟踪 ID,即 SQL 在数据节点的执行 ID。

14c93b7c7bf00000

PhysicRead

integer

物理读。

0

CpuTime

integer

CPU 执行时间,单位为微秒。

100

Writes

integer

RDS SQL Server 引擎的写入数。

10

Collection

string

预留参数。

None

TableName

string

Finish

string

任务是否完成。

  • 0:未完成

  • 1:已完成

说明

Finish 返回为 0,并且包含 JobId 字段时,说明当前请求为异步请求,无法直接获取返回结果,需要进一步根据 JobId 进行查询。查询时将 JobId 作为 Filters 的输入值,例如:Filters=[{"Key": "JobId", "Value": "******"}]

1

JobId

string

异步任务 ID。

MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE",
  "Success": "true",
  "Data": {
    "StartTime": 1596177993000,
    "EndTime": 1608888296000,
    "TotalRecords": 1,
    "Items": {
      "SQLLogRecord": [
        {
          "Ext": "None",
          "ExecuteTime": "2023-12-07T02:15:32Z",
          "OriginTime": 1701886532000,
          "HostAddress": "11.197.XX.XX",
          "UpdateRows": 0,
          "LogicRead": 0,
          "SqlText": "select resource_id as cluster_id, tpl_name \\n\\tfrom dbfree_alert_resource_tpl_ref\\n\\twhere user_id=? and type='cluster' group by resource_id, tpl_name",
          "LockTime": 0,
          "ScanRows": 0,
          "ThreadId": 0,
          "State": "0",
          "DBName": "testdb",
          "SqlType": "select",
          "AccountName": "testname",
          "PhysicSyncRead": 0,
          "PhysicAsyncRead": 0,
          "TrxId": "200000",
          "ReturnRows": 0,
          "Consume": 58,
          "Vip": "100.115.XX.XX",
          "NodeId": "pi-uf6k5f6g3912i****",
          "SqlId": "c67649d4a7fb62c4f8c7a447c52b5b17",
          "UseImciEngine": "true",
          "ParallelQueueTime": "2",
          "ParallelDegree": "10",
          "Scnt": 10,
          "Rows": 10,
          "Frows": 10,
          "TraceId": "14c93b7c7bf00000 ",
          "PhysicRead": 0,
          "CpuTime": 100,
          "Writes": 10,
          "Collection": "None",
          "TableName": ""
        }
      ]
    },
    "Finish": "1",
    "JobId": "MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The request parameters are invalid. 请求参数错误
403 NoPermission You are not authorized to do this action. 没有权限执行该操作

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

变更历史

更多信息,参考变更详情