本接口用于查询数据库实例的慢日志记录,支持按多种条件过滤和排序。
接口说明
InstanceId
为实例 ID,必填参数。StartTime
和EndTime
为查询的时间范围,必填参数。可以通过设置
PageNumber
和PageSize
来分页获取结果。支持通过
OrderBy
参数对结果进行排序,具体可排序字段请参考文档。使用
Filters
参数可以进一步细化查询条件,如按主机地址、SQL ID 等过滤。
某些数据库类型(如 pg 和 polarPG)不支持特定的排序方式,请根据实际情况选择合适的参数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
hdm:DescribeSlowLogRecords |
get |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
InstanceId |
string |
是 |
实例 id。 |
rm-8vbk4xz99su8**** |
NodeId |
string |
否 |
节点 id。 |
pi-d9j9fe7wq7t9i**** |
StartTime |
integer |
是 |
起始时间。 |
1596177993000 |
EndTime |
integer |
是 |
结束时间。 |
1634972640000 |
PageNumber |
integer |
否 |
页码,从 1 开始。 |
1 |
PageSize |
integer |
否 |
页大小。 |
10 |
Filters |
array |
否 |
筛选条件列表。 |
|
object |
否 |
筛选条件列表。 |
||
Key |
string |
否 |
过滤参数。 说明
详情请参见补充说明。 |
None |
Value |
string |
否 |
过滤参数取值。 |
None |
OrderBy |
string |
否 |
重要
RDS PostgreSQL、PolarDB PostgreSQL 和 SQLServer 不支持排序。 |
QueryTimeSeconds |
Asc |
boolean |
否 |
是否升序排序,默认为 true。
|
true |
Key 支持的参数和取值:
- RDS MySQL、PolarDB MySQL、RDS PostgreSQL、PolarDB PostgreSQL 版
hostAddress:来源,多个使用逗号分隔。
sqlId:SqlID,多个使用逗号分隔。
user:用户,多个使用逗号分隔。
dbName:数据库名称,多个使用逗号分隔。
tags:标签,多个使用逗号分隔。
- MongoDB
hostInsId:角色 ID,多个使用逗号分隔。
insRole:实例角色,多个使用逗号分隔。
opType:操作类型,多个使用逗号分隔。
namespace:命名空间,多个使用逗号分隔。
nodeType:组件类型,多个使用逗号分隔。
queryId:查询 ID,多个使用逗号分隔。
- 云数据库 Tair(兼容 redis)
hostAddress:来源。
user:用户。
dbName:数据库。
nodeType:节点类型。
- RDS SQL Server
hostAddress:来源,多个使用逗号分隔。
sqlId:SqlID,多个使用逗号分隔。
user:用户,多个使用逗号分隔。
dbName:数据库,多个使用逗号分隔。
tags:标签,多个使用逗号分隔。
- PolarDB-X
traceId:实例的跟踪 ID。
role:节点角色,取值 CN 或 DN(计算节点/存储节点),必传。
hostAddress:来源,多个使用逗号分隔。
sqlId:SqlID,多个使用逗号分隔。
user:user,多个使用逗号分隔。
dbName:数据库,多个使用逗号分隔。
tags:标签,多个使用逗号分隔。
SQL 引擎支持根据 sqlId 查询数据,且 sqlId 支持逗号分隔传入多个,最多 20 个。
MongoDB 支持根据 queryId 查询数据,且 queryId 支持逗号分隔传入多个,最多 20 个。
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
Code |
string |
返回的状态码。 |
200 |
Message |
string |
请求返回消息。 说明
请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Successful |
RequestId |
string |
请求 ID。 |
A1C79EE2-D04D-571B-8C60-961FAF8E**** |
Success |
string |
请求是否执行成功:
|
true |
Data |
object |
DBLogRecords |
|
DbInstanceName |
string |
实例 ID。 |
rm-bp157g54vy772**** |
NodeId |
string |
节点 id。 |
node123 |
ItemsNumbers |
integer |
当前页查询日志列表内的 Item 数量。 |
10 |
StartTime |
string |
起始时间。 |
1672531200000 |
EndTime |
string |
结束时间。 |
1672617600000 |
DbInstanceId |
integer |
实例数字 ID。 |
100 |
TotalRecords |
integer |
总记录数。 |
100 |
PageNumbers |
integer |
分页查询的页码,从 1 开始,默认为 1。 |
1 |
MaxRecordsPerPage |
integer |
分页查询每页最大记录数。取值范围:5~100。 |
20 |
Logs |
array |
返回数据。 |
|
object |
返回数据。 |
||
SqlId |
string |
SQL 模板 ID |
sqlId |
Scheme |
string |
数据 Schema |
HTTPS |
SubInstanceId |
string |
子实例 ID。 |
r-8vb219d10038**** |
DbInstanceName |
string |
实例 ID。 |
rm-2zebg30mk056g**** |
InsName |
string |
实例名字 |
test |
AccountName |
string |
用户。 |
user1 |
HostAddress |
string |
来源。 |
192.168.1.1 |
QueryStartTime |
string |
查询开始的时间。格式:yyyy-MM-dd hh:mm:ss(UTC 时间)。 |
2024-04-01 11:00:00 |
SQLText |
string |
sql 文本。 |
SELECT * FROM my_table WHERE ROWNUM <= 10 |
Psql |
string |
SQL 模板。 |
SELECT * FROM my_table WHERE ROWNUM <= 10 |
DBName |
string |
数据库名称。 |
test |
QueryTime |
integer |
查询耗时。 |
121 |
ReturnItemNumbers |
string |
返回项目编号。 |
test |
DocsExamined |
string |
MongoDB 该操作执行时扫描的文档数。 |
100 |
KeysExamined |
string |
MongoDB 索引扫描行数。 |
valueA |
TableName |
string |
表名。 |
tableNameExample |
LockTime |
number |
锁等待时间。 |
100 |
RowsExamined |
integer |
扫描行数。 |
100 |
RowsSent |
integer |
返回行数。 |
10 |
ThreadId |
string |
线程 ID。 |
57472578 |
Timestamp |
integer |
时间戳。 |
1747118812 |
SqlTag |
object |
标签。 |
|
SqlId |
string |
sqlid。 |
8ad7069f236bcdaaa9b3ae4b6299**** |
Tags |
string |
逗号分隔的多个 tag。 |
DAS_IMPORTANT,DAS_IN_PLAN |
Comments |
string |
备注信息。 |
test |
LockTimeSeconds |
number |
锁等待时间,单位为秒。 |
100 |
QueryTimeSeconds |
number |
查询耗时,单位秒。 |
100 |
SqlType |
string |
选择 SQL 的类型。
|
SELECT |
CPUTime |
number |
CPU 查询时间。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
50 |
IOWrites |
integer |
I/O 写次数。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
1 |
LastRowsCountAffected |
integer |
最后一条语句的影响行数。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
10 |
LogicalIOReads |
integer |
逻辑读次数。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
1 |
PhysicalIOReads |
integer |
物理读次数。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
1 |
RowsCountAffected |
integer |
影响的行数。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
10 |
Command |
string |
慢查询语句。 说明
仅云数据库 Tair(兼容 Redis)实例支持。 |
SELECT |
Namespace |
string |
命名空间。 说明
仅云数据库 MongoDB 版实例支持。 |
pro-test |
QueryId |
string |
Query ID。 说明
仅云数据库 MongoDB 版实例支持。 |
sq-1pzcdMwRb |
ReturnNum |
string |
返回行数。 说明
仅云数据库 MongoDB 版实例支持。 |
20 |
ApplicationName |
string |
应用名。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
MyApp |
CPUTimeSeconds |
number |
CPU 查询时间,单位秒。 说明
仅云数据库 RDS SQL Server 版实例支持。 |
100 |
Rows |
integer |
PolarDB-X 2.0 数据库实例计算节点总更新或返回的行数。 说明
仅云数据库 PolarDB-X 2.0 版实例支持。 |
20 |
Frows |
integer |
PolarDB-X 2.0 计算节点(CN)的拉取行数。 说明
仅云数据库 PolarDB-X 2.0 版实例支持。 |
10 |
Scnt |
integer |
PolarDB-X 2.0 计算节点(CN)的 DN 请求数。 说明
仅云数据库 PolarDB-X 2.0 版实例支持。 |
10 |
TraceId |
string |
PolarDB-X 2.0 的跟踪 ID,即 SQL 在数据节点的执行 ID。 说明
仅云数据库 PolarDB-X 2.0 版实例支持。 |
074ce334-5247-40b9-b0c1-158aea5d**** |
TemplateId |
string |
PolarDB-X 2.0 模板 ID。 说明
仅云数据库 PolarDB-X 2.0 版实例支持。 |
6a63b6ac4572abfaef7d1163f684**** |
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "Successful",
"RequestId": "A1C79EE2-D04D-571B-8C60-961FAF8E****",
"Success": "true",
"Data": {
"DbInstanceName": "rm-bp157g54vy772****",
"NodeId": "node123",
"ItemsNumbers": 10,
"StartTime": "1672531200000",
"EndTime": "1672617600000",
"DbInstanceId": 100,
"TotalRecords": 100,
"PageNumbers": 1,
"MaxRecordsPerPage": 20,
"Logs": [
{
"SqlId": "sqlId",
"Scheme": "HTTPS",
"SubInstanceId": "r-8vb219d10038****",
"DbInstanceName": "rm-2zebg30mk056g****",
"InsName": "test",
"AccountName": "user1",
"HostAddress": "192.168.1.1",
"QueryStartTime": "2024-04-01 11:00:00",
"SQLText": "SELECT * FROM my_table WHERE ROWNUM <= 10",
"Psql": "SELECT * FROM my_table WHERE ROWNUM <= 10\n",
"DBName": "test",
"QueryTime": 121,
"ReturnItemNumbers": "test",
"DocsExamined": "100",
"KeysExamined": "valueA",
"TableName": "tableNameExample",
"LockTime": 100,
"RowsExamined": 100,
"RowsSent": 10,
"ThreadId": "57472578",
"Timestamp": 1747118812,
"SqlTag": {
"SqlId": "8ad7069f236bcdaaa9b3ae4b6299****",
"Tags": "DAS_IMPORTANT,DAS_IN_PLAN",
"Comments": "test"
},
"LockTimeSeconds": 100,
"QueryTimeSeconds": 100,
"SqlType": "SELECT",
"CPUTime": 50,
"IOWrites": 1,
"LastRowsCountAffected": 10,
"LogicalIOReads": 1,
"PhysicalIOReads": 1,
"RowsCountAffected": 10,
"Command": "SELECT",
"Namespace": "pro-test",
"QueryId": "sq-1pzcdMwRb",
"ReturnNum": "20",
"ApplicationName": "MyApp",
"CPUTimeSeconds": 100,
"Rows": 20,
"Frows": 10,
"Scnt": 10,
"TraceId": "074ce334-5247-40b9-b0c1-158aea5d****",
"TemplateId": "6a63b6ac4572abfaef7d1163f684****"
}
]
}
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | |
403 | NoPermission | You are not authorized to do this action. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。