You need to enable JavaScript to run this app.
文档中心
缓存数据库 Redis 版

缓存数据库 Redis 版

复制全文
下载 pdf
日志管理
DescribeSlowLogs
复制全文
下载 pdf
DescribeSlowLogs
调用 DescribeSlowLogs 接口查询目标 Redis 实例在指定时间内的慢日志详情。​
请求类型​
同步请求。​
注意事项​
  • 仅支持查看最近 3 天内的慢日志详情。​
  • Block 类命令的执行时长、通信时长和等待时长超过了阈值也不会被记录到慢日志中。更多详情,请参见查询慢日志。​
  • ​
    命令族​
    具体命令​
    Lists​
    BLPOP、BRPOP、BRPOPLPUSH​
    SortedSets​
    BZPOPMIN、BZPOPMAX​
    Streams​
    XREAD、XREADGROUP​
    ​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
redis-cn02sg5o56sbs****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。​
PageSize​
Integer​
是​
50​
每页记录数,取值范围为 1~1000。​
NodeIds​
Array of String​
否​
["proxy-redis-cn02sg5o56sbs****-1", "proxy-redis-cn02sg5o56sbs****-0"]​
需要查询慢日志的节点 ID。​
说明​
  • 若该参数留空,默认查询目标实例内所有节点的慢日志详情。​
  • 您可以调用 DescribeNodeIds 接口查询目标 Redis 实例下所有的节点 ID 信息。​
  • NodeIds的字符串总长度不可以超过 1024 个字节,建议传入的节点数量不超过 8 个。​
SlowLogType​
String​
否​
Proxy​
慢日志的类型。取值范围如下:​
  • Server:Server 节点慢日志。​
  • Proxy:Proxy 节点慢日志。​
说明​
  • 若该参数留空,默认返回所有节点类型的慢日志。​
  • 若同时传入 NodeIds 和 SlowLogType,以 NodeIds取值为准。​
QueryStartTime​
String​
否​
2022-07-26T12:37:54Z​
查询开始时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
说明​
若该参数留空,实际查询开始时间默认为当前时间 3 天前的时间。​
例如,当前时间为 2022 年 08 月 01 号 16:30:00,若 QueryStartTime不填,那么实际查询开始时间为 2022 年 07 月 29 号 16:30:00。​
QueryEndTime​
String​
否​
2022-07-26T12:38:54Z​
查询结束时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
说明​
  • 若该参数留空,实际查询结束时间默认为当前时间。​
  • 查询结束时间需晚于查询开始时间。​
DBName​
String​
否​
0​
慢日志所在的数据库。​
慢日志类型不同,支持的数据库取值范围不同,其中:​
  • Proxy 节点慢日志:0 到 256 间的任意整数。​
  • Server 节点慢日志:由于 Server 节点慢日志的数据库为空,故取值仅支持-。​
说明​
若该参数留空,默认返回所有数据库上的慢日志。​
Context​
String​
否​
[1658839101000000,69550,0,null]​
慢日志记录查询结果的上下文,需要加载更多慢日志记录时使用。​
说明​
调用 DescribeSlowLogs 接口后,您可以根据返回参数 ListOver 的值来确定是否还有未加载的慢日志记录:​
  • 若 ListOver 的值为 false,表示还有符合查询条件的慢日志记录未加载完,您可以再次调用 DescribeSlowLogs 接口,并使用上一次接口调用时返回参数中的 Context 值来查看剩余的慢日志记录。​
  • 若 ListOver 的值为 true,表示已加载完全部符合查询条件的慢日志记录。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Total​
Integer​
1​
查询结果总条目数。​
InstanceId​
String​
redis-cn02sg5o56sbs****​
实例 ID。​
ListOver​
Boolean​
true​
慢日志内容是否已全部加载。取值范围如下:​
  • true:已全部加载。​
  • false:未全部加载。​
说明​
若 ListOver 返回 false,您可以再次调用 DescribeSlowLogs,并在请求参数中传入 Context返回的值,来查询未加载完的慢日志详情。​
Context​
String​
[1658839101000000,69550,0,null]​
慢日志记录查询结果的上下文,需要加载更多慢日志记录时使用。​
SlowQuery​
Array of SlowQueryInfo​
请参见返回示例。​
慢日志详情。​
​
SlowQueryInfo​
​
参数​
类型​
示例值​
描述​
InstanceId​
String​
redis-cn02sg5o56sbs****​
实例 ID。​
NodeId​
String​
proxy-redis-redis-cn02sg5o56sbs****-0​
慢日志所属的节点 ID。​
DBName​
String​
0​
数据库名称。​
说明​
仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空(即 -)。​
UserName​
String​
default​
账号名称。​
说明​
仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空(即 -)。​
ExecutionStartTime​
String​
2022-07-26T12:37:38Z​
慢查询语句的执行开始时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
QueryText​
String​
INFO​
慢查询语句。​
QueryTimes​
Long​
22073438​
慢查询语句执行时长,单位:微秒(us)。​
HostAddress​
String​
172.22..:47502​
发出慢查询请求的客户端地址。​
说明​
仅 Proxy 节点上的慢日志才会返回该信息。Server 节点慢日志该值默认为空(即 -)。​
​
示例​
请求示例​
​
POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeSlowLogs&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
"InstanceId":"redis-cn02sg5o56sbs****",​
"NodeIds":[​
"proxy-redis-cn02sg5o56sbs****-0",​
"proxy-redis-cn02sg5o56sbs****-1"​
],​
"QueryStartTime":"2022-07-26T12:37:54Z",​
"QueryEndTime":"2022-07-26T12:38:54Z",​
"PageSize":50​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2022072620484801022508421701070107",​
"Action": "DescribeSlowLogs",​
"Version": "2020-12-07",​
"Service": "Redis",​
"Region": "cn-beijing"​
},​
"Result": {​
"Context": "[1658839101000000,69550,0,null]",​
"InstanceId": "redis-cn02sg5o56sbs****",​
"ListOver": true,​
"SlowQuery": [​
{​
"DBName": "0",​
"ExecutionStartTime": "2022-07-26T12:37:38Z",​
"HostAddress": "172.22.***.***:47502",​
"InstanceId": "redis-redis-cn02sg5o56sbs****",​
"NodeId": "proxy-redis-redis-cn02sg5o56sbs****-0",​
"QueryText": "INFO",​
"QueryTimes": 22073438,​
"UserName": "default"​
}​
],​
"Total": 1​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.21 14:23:31
这个页面对您有帮助吗?
有用
有用
无用
无用