获取审计日志热数据。
接口说明
使用该接口需满足以下前提条件:
- 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
- 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
- 适用于 Polar MySQL、RDS MYSQL、RDS PostgreSQL、RDS SQLServer。
说明
查询开始时间不能早于 7 天以前,查询开始时间和查询结束时间的间隔不能超过 1 天,并且该 API 返回的条数最多为 1W 条。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 数据库实例 ID。 | rm-2ze1jdv45i7l6**** |
Start | long | 是 | 查询开始时间,格式为 Unix 时间戳,单位为毫秒。 说明
只能查询开启 DAS 企业版后的数据,查询开始时间最大不能早于当前时间 7 天。
| 1684734297000 |
End | long | 是 | 查询结束时间,格式为 Unix 时间戳,单位为毫秒。 说明
查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过 1 天。
| 1684820697000 |
QueryKeyword | string | 否 | 关键字。 说明
不支持模糊查询;支持多个关键字组合查询,关键字间以空格分隔。
| test |
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 |
MaxLatancy | long | 否 | 最大执行耗时 ,单位为微秒。查询执行耗时小于该参数值的 SQL 语句。 | 100 |
MaxScanRows | long | 否 | 最大扫描行数 ,查询扫描行数小于该参数值的 SQL 语句。 | 10000 |
MinLatancy | long | 否 | 最小执行耗时 ,单位为微秒。查询执行耗时大于等于该参数值的 SQL 语句。 | 10 |
MinScanRows | long | 否 | 最小扫描行数 ,查询扫描行数大于等于该参数值的 SQL 语句。 | 10 |
SqlType | string | 否 | SQL 语句的类型。取值:
枚举值:
| SELECT |
State | string | 否 | 执行结果,输入 0 时表示查询执行成功的 SQL,您也可以输入具体的错误码,查询对应的 SQL。 | 0 |
ThreadID | string | 否 | 线程 ID。 说明
支持多个线程 ID 组合查询,线程 ID 间以空格分隔,例如: 线程 ID1 线程 ID2 线程 ID3 。
| 657 |
PageNumbers | long | 否 | 分页查询的页码,从 1 开始,默认为 1。 | 2 |
MaxRecordsPerPage | long | 否 | 分页查询每页最大记录数。取值范围:5~100。 | 10 |
SortKey | string | 否 | 排序依据。
| SCAN_ROWS |
SortMethod | string | 否 | 排序方式。
| ase |
ChildDBInstanceIDs | string | 否 | 节点 ID。 说明
对于 PolarDB MySQL 版实例,需要提供节点 ID。
| pi-bp179lg03445l**** |
Role | string | 否 | 预留参数,暂不支持。 | None |
TraceId | string | 否 | 预留参数,暂不支持。 | None |
MinRows | long | 否 | 预留参数,暂不支持。 | None |
MaxRows | long | 否 | 预留参数,暂不支持。 | None |
MinSpillCnt | long | 否 | 预留参数,暂不支持。 | None |
MaxSpillCnt | long | 否 | 预留参数,暂不支持。 | None |
TransactionId | string | 否 | 事务 ID。 | 0 |
Fail | string | 否 | SQL 执行错误码,您可以调用 GetAsyncErrorRequestStatByCode 获取错误码。 | 1064 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Data": {
"Extra": "None",
"List": [
{
"AccountName": "testuser",
"DBName": "testDB",
"ExecuteTime": "2023-05-23 T12:11:20Z",
"Ext": "None",
"HostAddress": "47.100.XX.XX",
"Latancy": 10000,
"LockTime": 1,
"LogicRead": 12,
"OriginTime": "2023-05-23 T12:11:20.999Z",
"PhysicAsyncRead": 0,
"PhysicSyncRead": 0,
"ReturnRows": 1,
"SQLText": "select 1",
"ScanRows": 29,
"SqlType": "SELECT",
"State": "0",
"ThreadID": 657,
"TransactionId": "0",
"UpdateRows": 30
}
],
"PageNo": 2,
"PageSize": 10,
"Total": 20
},
"Message": "Successful",
"RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
"Success": "true"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-04 | OpenAPI 错误码发生变更 | 查看变更详情 |