1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(DescribeSlowLog)查询实例慢查询记录。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSlowLog。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。 示例值:crs-asdasdas |
BeginTime | 是 | String | 预查询慢日志的起始时间,查询时间最大跨度30天。 示例值:2019-09-08 12:12:41 |
EndTime | 是 | String | 预查询慢日志的结束时间,查询时间最大跨度30天 示例值:2019-09-09 12:12:41 |
MinQueryTime | 否 | Integer | 慢查询平均执行时间阈值,单位:毫秒。 示例值:100 |
Limit | 否 | Integer | 每个页面展示的慢查询条数,默认值为20,最大100。 示例值:20 |
Offset | 否 | Integer | 慢查询条数的偏移量,取Limit整数倍。计算公式:offset=limit*(页码-1)。 示例值:0 |
Role | 否 | String | 节点所属角色。 - master:主节点。 - slave:从节点。 示例值:master |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 慢查询总数。 示例值:30 |
InstanceSlowlogDetail | Array of InstanceSlowlogDetail | 已废弃,该参数存在命名不规范问题,后续用参数InstanceSlowLogDetail取代。慢查询详情。 |
InstanceSlowLogDetail | Array of InstanceSlowlogDetail | 慢查询详情。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例慢查询记录
通过 DescribeSlowLog 接口查询一实例的慢查询详情,包含:慢查询的命令、命令行信息、延迟时间、客户端地址、节点ID等信息。
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSlowLog
<公共请求参数>
{
"InstanceId": "crs-asda****",
"EndTime": "2019-09-09 12:12:41",
"BeginTime": "2019-09-08 12:12:41"
}
输出示例
{
"Response": {
"InstanceSlowlogDetail": [
{
"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7********",
"Command": "hget",
"CommandLine": "hget hash_key classify_scope::default",
"Duration": 45,
"ExecuteTime": "2019-09-08 12:13:08",
"Client": ""
},
{
"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7********",
"Command": "keys",
"CommandLine": "keys OtherResControler:orion.ovs.client.1514259512471:orion.ovs.entprise.9281083591:sence:*",
"Duration": 41,
"ExecuteTime": "2019-09-08 12:13:08",
"Client": ""
},
{
"Node": "24a05f0d545da235f07a5bc5deebb937********",
"Command": "get",
"CommandLine": "get slot::fsm::status::orion.ovs.client.1508751991541::1db7ffcf9216bc1fd939e6c710514f6fb40fd4fe1525f",
"Duration": 41,
"ExecuteTime": "2019-09-08 12:13:08",
"Client": ""
}
],
"InstanceSlowLogDetail": [
{
"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7********",
"Command": "hget",
"CommandLine": "hget hash_key classify_scope::default",
"Duration": 45,
"ExecuteTime": "2019-09-08 12:13:08",
"Client": ""
},
{
"Node": "833a2f6d8b402319aee8ad7f1c0fbbf7********",
"Command": "keys",
"CommandLine": "keys OtherResControler:orion.ovs.client.1514259512471:orion.ovs.entprise.9281083591:sence:*",
"Duration": 41,
"ExecuteTime": "2019-09-08 12:13:08",
"Client": ""
},
{
"Node": "24a05f0d545da235f07a5bc5deebb937********",
"Command": "get",
"CommandLine": "get slot::fsm::status::orion.ovs.client.1508751991541::1db7ffcf9216bc1fd939e6c710514f6fb40fd4fe1525f",
"Duration": 41,
"ExecuteTime": "2019-09-08 12:13:08",
"Client": ""
}
],
"RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6",
"TotalCount": 106980
}
}
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.SystemError | 内部系统错误,和业务无关。 |
InternalError.DbOperationFailed | 统一的 DB 操作错误,可以是 update insert select..。 |
InvalidParameter.EmptyParam | 参数为空。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |
InvalidParameterValue.UnSupportedType | 实例类型不支持。 |
ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
ResourceUnavailable.InstanceStatusError | 实例状态异常,不能执行对应操作。 |