文档

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

更新时间:

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

接口说明

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

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

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

授权信息

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

请求参数

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

数据库实例 ID。

pc-2ze8g2am97624****
NodeIdstring

节点 ID。

  • 对于 RDS MySQL 和 PolarDB MySQL 版,该参数仅适用于集群版实例。若不传该参数,默认查询主节点日志明细。
  • 对于 PolarDB-X 2.0,该参数传入polarx_cn(计算节点)或polarx_dn(数据节点)。
pi-uf6k5f6g3912i****
Rolestring

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

  • **polarx_cn **:计算节点。
  • **polarx_dn **:数据节点。
polarx_cn
Filtersobject []

筛选条件列表。

Keystring

过滤参数。

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

过滤参数取值。

select
StartTimelong

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

1596177993000
EndTimelong

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

1608888296000
PageNointeger

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

1
PageSizeinteger

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

10

Key 支持的参数和取值:

  • KeyWords:关键字,多个关键字间使用空格隔开。
  • LogicalOperator:关键字间的逻辑操作,取值为 and 或 or。
  • AccountName:用户名。
  • dbName:数据库名称。
  • HostAddress:客户端 IP 地址。
  • MaxConsume:最大耗时,单位毫秒。
  • MinConsume:最小耗时,单位毫秒。
  • 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:对于开通企业版 V0 和 V1 的数据库实例,需要通过异步任务 ID 进一步查询返回结果。

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

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

请求 ID。

F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true
Dataobject

返回数据。

StartTimelong

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

1596177993000
EndTimelong

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

1608888296000
TotalRecordslong

总记录数。

1
Itemsobject

列表数据

SQLLogRecordobject []

SQL 日志数据。

Extstring

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

None
ExecuteTimestring

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

2023-12-07T02:15:32Z
OriginTimelong

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

1701886532000
HostAddressstring

客户端 IP 地址。

11.197.XX.XX
UpdateRowslong

更新行数。

0
LogicReadlong

逻辑读。

0
SqlTextstring

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
LockTimelong

锁等待时间,单位毫秒。

0
ScanRowslong

扫描行数。

0
ThreadIdlong

线程 ID。

None
Statestring

执行状态。

  • 0:执行成功。
  • 1:执行失败。
0
DBNamestring

数据库名称。

testdb
SqlTypestring

SQL 语句的类型。

select
AccountNamestring

数据库账号。

testname
PhysicSyncReadlong

物理同步读。

0
PhysicAsyncReadlong

物理异步读。

0
TrxIdlong

事务 ID。

200000
ReturnRowslong

返回行数。

0
Consumelong

执行耗时,单位毫秒。

58
Vipstring

查询链接的 endpoint 解析地址。

100.115.XX.XX
NodeIdstring

节点 ID。

pi-uf6k5f6g3912i****
SqlIdstring

SQL ID。

c67649d4a7fb62c4f8c7a447c52b5b17
UseImciEnginestring

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

  • true:是。
  • false:否。
true
ParallelQueueTimestring

PolarDB MySQL 版实例的并行度。

2
ParallelDegreestring

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

10
Scntlong

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

10
Rowslong

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

10
Frowslong

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

10
TraceIdstring

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

14c93b7c7bf00000
PhysicReadlong

物理读。

0
CpuTimelong

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

100
Writeslong

RDS SQL Server 引擎的写入数。

10
Collectionstring

预留参数。

None
Finishstring

任务是否完成。

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

异步任务 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"
        }
      ]
    },
    "Finish": "1",
    "JobId": "MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465"
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

  • 本页导读
文档反馈