查看PolarDB集群的慢日志明细。
接口说明
仅 PolarDB MySQL 版集群支持调用该接口。
PolarDB PostgreSQL 版与 PolarDB PostgreSQL 版(兼容 Oracle)集群请使用 DAS 慢日志记录查询接口。
2024 年 09 月 01 日起,由于 SQL 模板化算法优化,调用本接口时,SQLHash 字段的值将发生变更。详情请参见【通知】慢 SQL 的模板化算法优化。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
        
            调试
        
    
授权信息
| 
                                 操作  | 
                            
                                 访问级别  | 
                            
                                 资源类型  | 
                            
                                 条件关键字  | 
                            
                                 关联操作  | 
                        
| 
                                 polardb:DescribeSlowLogRecords  | 
                            
                                 get  | 
                            
                                     *dbcluster 
  | 
                            无 | 无 | 
请求参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             必填  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| RegionId | 
                             string  | 
                        
                             是  | 
                        
                             地域 ID。 说明 
 您可以调用 DescribeRegions 接口查看目标账号下的可用地域信息,包括地域 ID。  | 
                        
                             cn-hangzhou  | 
                    
| DBClusterId | 
                             string  | 
                        
                             是  | 
                        
                             集群 ID。 说明 
 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息,包括集群 ID。  | 
                        
                             pc-************  | 
                    
| NodeId | 
                             string  | 
                        
                             否  | 
                        
                             节点 ID  | 
                        
                             pi-**********  | 
                    
| StartTime | 
                             string  | 
                        
                             是  | 
                        
                             查询开始时间。格式为 说明 
 
  | 
                        
                             2022-11-15T16:00Z  | 
                    
| EndTime | 
                             string  | 
                        
                             是  | 
                        
                             查询结束时间,需要晚于查询开始时间,且查询开始时间与结束时间的时间间隔需在 24 小时之内。格式为 说明 
 该参数输入的是 UTC 时间(即 0 时区),如果您的服务当前处于其他时区,请您进行时间转换。例如,当前您的服务所在时区的时间是北京时间(UTC+8 时间)12:00 点,如果您需要查询北京时间 08:00 点-12:00 点的慢日志信息,那么应该输入的时间是 00:00 点-04:00 点。  | 
                        
                             2022-11-16T04:00Z  | 
                    
| DBName | 
                             string  | 
                        
                             否  | 
                        
                             数据库名称。  | 
                        
                             testdb  | 
                    
| PageSize | 
                             integer  | 
                        
                             否  | 
                        
                             每页记录数,取值范围如下: 
 默认值为 30。  | 
                        
                             30  | 
                    
| PageNumber | 
                             integer  | 
                        
                             否  | 
                        
                             页码,取值范围为大于 0 且不超过 Integer 的最大值。 默认值为 1。  | 
                        
                             1  | 
                    
| SQLHASH | 
                             string  | 
                        
                             否  | 
                        
                             慢日志统计里的 SQL 语句唯一标识符,可用于获取该 SQL 语句的慢日志明细。  | 
                        
                             U2FsdGVk****  | 
                    
返回参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| 
                             object  | 
                        |||
| DBClusterId | 
                             string  | 
                        
                             集群 ID。  | 
                        
                             pc-*****************  | 
                    
| Engine | 
                             string  | 
                        
                             数据库引擎。  | 
                        
                             polardb_mysql  | 
                    
| Items | 
                             object  | 
                        ||
| SQLSlowRecord | 
                             array<object>  | 
                        
                             慢日志明细列表。  | 
                        |
| 
                             object  | 
                        |||
| DBName | 
                             string  | 
                        
                             数据库名称。  | 
                        
                             testdb  | 
                    
| DBNodeId | 
                             string  | 
                        
                             节点 ID。  | 
                        
                             pi-*****************  | 
                    
| ExecutionStartTime | 
                             string  | 
                        
                             SQL 开始执行的时间。格式为  | 
                        
                             2021-04-07T03:47Z  | 
                    
| HostAddress | 
                             string  | 
                        
                             连接数据库的客户端地址。  | 
                        
                             testdb[testdb] @ [100.**.**.242]  | 
                    
| LockTimes | 
                             integer  | 
                        
                             SQL 锁定时长,单位为秒。  | 
                        
                             0  | 
                    
| ParseRowCounts | 
                             integer  | 
                        
                             解析行数。  | 
                        
                             0  | 
                    
| QueryTimeMS | 
                             integer  | 
                        
                             查询时间。单位毫秒。  | 
                        
                             100  | 
                    
| QueryTimes | 
                             integer  | 
                        
                             SQL 执行时长,单位为秒。  | 
                        
                             20  | 
                    
| ReturnRowCounts | 
                             integer  | 
                        
                             返回行数。  | 
                        
                             0  | 
                    
| SQLHash | 
                             string  | 
                        
                             慢日志统计里的 SQL 语句唯一标识符  | 
                        
                             U2FsdGVk****  | 
                    
| SQLText | 
                             string  | 
                        
                             查询语句。  | 
                        
                             /* Query from *** by user 111 */ SELECT sleep(20)  | 
                    
| PageNumber | 
                             integer  | 
                        
                             页码。  | 
                        
                             1  | 
                    
| PageRecordCount | 
                             integer  | 
                        
                             本页记录数。  | 
                        
                             1  | 
                    
| RequestId | 
                             string  | 
                        
                             请求 ID。  | 
                        
                             A7E6A8FD-C50B-46B2-BA85-D8B8D3******  | 
                    
| TotalRecordCount | 
                             integer  | 
                        
                             总 SQL 语句个数。  | 
                        
                             1  | 
                    
示例
正常返回示例
JSON格式
{
  "DBClusterId": "pc-*****************",
  "Engine": "polardb_mysql",
  "Items": {
    "SQLSlowRecord": [
      {
        "DBName": "testdb",
        "DBNodeId": "pi-*****************",
        "ExecutionStartTime": "2021-04-07T03:47Z",
        "HostAddress": "testdb[testdb] @  [100.**.**.242]",
        "LockTimes": 0,
        "ParseRowCounts": 0,
        "QueryTimeMS": 100,
        "QueryTimes": 20,
        "ReturnRowCounts": 0,
        "SQLHash": "U2FsdGVk****",
        "SQLText": "/* Query from *** by user 111 */ SELECT sleep(20)"
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 1,
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "TotalRecordCount": 1
}
            错误码
| 
                                 HTTP status code  | 
            				
                                 错误码  | 
            				
                                 错误信息  | 
            				
                                 描述  | 
            			
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | 指定的参数StartTime无效 | 
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 | 
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。