1. 接口描述
接口请求域名： dbbrain.tencentcloudapi.com 。
按照Sql模板+schema的聚合方式，统计排序指定时间段内的top慢sql。
默认接口请求频率限制：5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSlowLogTopSqls。 |
| Version | 是 | String | 公共参数，本接口取值：2019-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID 。 示例值：cdb-test123 |
| StartTime | 是 | Timestamp | 开始时间，如“2019-09-10 12:13:14”。 示例值：2019-09-10 12:13:14 |
| EndTime | 是 | Timestamp | 截止时间，如“2019-09-10 12:13:14”，截止时间与开始时间的间隔最大可为7天。 示例值：2019-09-10 12:13:14 |
| SortBy | 否 | String | 排序键，目前支持 QueryTime,ExecTimes,RowsSent,LockTime以及RowsExamined 等排序键。 示例值：QueryTime |
| OrderBy | 否 | String | 排序方式，支持ASC（升序）以及DESC（降序）。 示例值：DESC |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。 示例值：20 |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：0 |
| SchemaList.N | 否 | Array of SchemaItem | 数据库名称数组。 示例值：- |
| Product | 否 | String | 服务产品类型，支持值包括： "mysql" - 云数据库 MySQL， "cynosdb" - 云数据库 CynosDB for MySQL，默认为"mysql"。 示例值：mysql |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的记录总数。 示例值：10 |
| Rows | Array of SlowLogTopSqlItem | 慢日志 top sql 列表 示例值：- |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按照Sql模板查询指定时间段内的慢日志统计结果
按照Sql模板查询指定时间段内的慢日志统计结果。
输入示例
https://dbbrain.tencentcloudapi.com/?Action=DescribeSlowLogTopSqls
&InstanceId=test
&SortBy=QueryTime
&OrderBy=ASC
&Limit=10
&Offset=0
&StartTime=2019-01-01 00:00:00
&EndTime=2019-01-01 01:00:00
&SchemaList.0.Schema=dbName
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "",
"TotalCount": 1,
"Rows": [
{
"RowsExaminedMax": 0,
"ExecTimes": 2,
"RowsSentMax": 0,
"QueryTimeRatio": 100,
"LockTimeRatio": 0,
"LockTimeMin": 0,
"RowsExaminedRatio": 0,
"Schema": "dbName",
"SqlText": "select test from test",
"QueryTime": 28.17341,
"SqlTemplate": "select ? from ?",
"QueryTimeMax": 14.086705,
"LockTime": 0,
"RowsSent": 0,
"RowsSentMin": 0,
"LockTimeMax": 0,
"RowsSentRatio": 0,
"RowsExamined": 0,
"RowsExaminedMin": 0,
"QueryTimeMin": 0,
"RowsSentAvg": 0,
"LockTimeAvg": 0,
"RowsExaminedAvg": 0,
"QueryTimeAvg": 0
}
]
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |