GetDasSQLLogHotData - 查询DAS企业版热存储数据明细

更新时间:
复制 MD 格式

获取审计日志热数据。

接口说明

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

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

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

  • 适用于 Polar MySQL、RDS MYSQL、RDS PostgreSQL、RDS SQLServer。

  • 实例已开启日志索引。

说明

查询开始时间不能早于 7 天以前,查询开始时间和查询结束时间的间隔不能超过 1 天,并且该 API 返回的条数最多为 1W 条。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hdm:GetDasSQLLogHotData

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

数据库实例 ID。

rm-2ze1jdv45i7l6****

Start

integer

是

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

说明

只能查询开启 DAS 企业版后的数据,查询开始时间最大不能早于当前时间 7 天。

1684734297000

End

integer

是

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

说明

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

1684820697000

QueryKeyword

string

否

关键字。

说明

支持模糊查询;最多支持 10 个关键字组合查询,关键字之间以空格分隔。例如:a1 b2 c3。

a1 b2

AccountName

string

否

数据库账号。

说明

支持多个数据库账号组合查询,数据库账号间以空格分隔,例如:user1 user2 user3。

testuser

DBName

string

否

数据库名。

说明

支持多个数据库名组合查询,数据库名间以空格分隔,例如:DB1 DB2 DB3。

testDB

HostAddress

string

否

客户端 IP 地址。

说明

支持多个客户端 IP 地址组合查询,客户端 IP 地址间以空格分隔,例如:IP1 IP2 IP3。

47.100.XX.XX

LogicalOperator

string

否

多个关键字的逻辑关系。

  • or:或。

  • and:与。

or

MaxLatancy

integer

否

最大执行耗时 ,单位为微秒。查询执行耗时小于该参数值的 SQL 语句。

100

MaxScanRows

integer

否

最大扫描行数 ,查询扫描行数小于该参数值的 SQL 语句。

10000

MinLatancy

integer

否

最小执行耗时 ,单位为微秒。查询执行耗时大于等于该参数值的 SQL 语句。

10

MinScanRows

integer

否

最小扫描行数 ,查询扫描行数大于等于该参数值的 SQL 语句。

10

SqlType

string

否

SQL 语句的类型。取值:

  • select

  • update

  • delete

枚举值:

  • select :

    查询

  • update :

    修改

  • delete :

    删除

select

State

string

否

执行结果,输入 0 时表示查询执行成功的 SQL,您也可以输入具体的错误码,查询对应的 SQL。

0

ThreadID

string

否

线程 ID。

说明

支持多个线程 ID 组合查询,线程 ID 间以空格分隔,例如:线程 ID1 线程 ID2 线程 ID3。

657

PageNumbers

integer

否

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

2

MaxRecordsPerPage

integer

否

分页查询每页最大记录数。取值范围:5~100。

10

SortKey

string

否

排序依据。

  • ScanRows:扫描行数。

  • UpdateRows:更新行数。

  • Consume:耗时。

  • OriginTime:执行时间。

  • ReturnRows:返回行数。

ScanRows

SortMethod

string

否

排序方式。

  • ASC:正序。

  • DESC:倒序。

ASC

ChildDBInstanceIDs

string

否

节点 ID。

说明

对于 PolarDB MySQL 版实例,需要提供节点 ID。

pi-bp179lg03445l****

Role

string

否

预留参数,暂不支持。

None

TraceId

string

否

预留参数,暂不支持。

None

MinRows

integer

否

预留参数,暂不支持。

None

MaxRows

integer

否

预留参数,暂不支持。

None

MinSpillCnt

integer

否

预留参数,暂不支持。

None

MaxSpillCnt

integer

否

预留参数,暂不支持。

None

TransactionId

string

否

事务 ID。

0

Fail

string

否

SQL 执行错误码,您可以调用 GetAsyncErrorRequestStatByCode 获取错误码。

1064

返回参数

名称

类型

描述

示例值

object

Code

string

返回的状态码。

200

Message

string

请求返回消息。

说明

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

Successful

RequestId

string

请求 ID,阿里云为该请求生成的标识符。

0A74B755-98B7-59DB-8724-1321B394****

Success

string

请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true

Data

object

返回数据。

List

array<object>

返回信息列表。

object

返回 SQL 洞察和审计数据。

Latancy

integer

执行耗时,单位微秒。

10000

Ext

string

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

None

ExecuteTime

string

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

2023-05-23 T12:11:20Z

OriginTime

string

执行时间,格式为 UTC 时间:yyyy-MM-ddTHH:mm:ss.SSSZ。

2023-05-23 T12:11:20.999Z

HostAddress

string

客户端 IP 地址。

47.100.XX.XX

UpdateRows

integer

更新行数。

30

LogicRead

integer

逻辑读。

12

SQLText

string

SQL 语句详情。

select 1

LockTime

integer

锁等待时间,单位微秒。

1

ScanRows

integer

扫描行数。

29

ThreadID

integer

线程 ID。

657

State

string

状态。返回 0 时表示执行成功,否则返回错误码。

0

DBName

string

数据库名称。

testDB

SqlType

string

SQL 的类型。取值:

  • select

  • update

  • delete

select

AccountName

string

数据库账号。

testuser

PhysicSyncRead

integer

物理同步读。

0

PhysicAsyncRead

integer

物理异步读。

0

TransactionId

string

开启的事务 ID。

0

ReturnRows

integer

返回行数。

1

NodeId

string

节点 ID。

pi-bp120roy76f3qbd84

Total

integer

返回总记录数。

20

PageNo

integer

分页页码。

2

PageSize

integer

每页数量。

10

Extra

any

备用参数。

None

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": "true",
  "Data": {
    "List": [
      {
        "Latancy": 10000,
        "Ext": "None",
        "ExecuteTime": "2023-05-23 T12:11:20Z",
        "OriginTime": "2023-05-23 T12:11:20.999Z",
        "HostAddress": "47.100.XX.XX",
        "UpdateRows": 30,
        "LogicRead": 12,
        "SQLText": "select 1",
        "LockTime": 1,
        "ScanRows": 29,
        "ThreadID": 657,
        "State": "0",
        "DBName": "testDB",
        "SqlType": "select",
        "AccountName": "testuser",
        "PhysicSyncRead": 0,
        "PhysicAsyncRead": 0,
        "TransactionId": "0",
        "ReturnRows": 1,
        "NodeId": "pi-bp120roy76f3qbd84"
      }
    ],
    "Total": 20,
    "PageNo": 2,
    "PageSize": 10,
    "Extra": "None"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

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

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

变更历史

更多信息,参考变更详情。