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

缓存数据库 Redis 版

复制全文
下载 pdf
日志管理
DescribeFatLogs
复制全文
下载 pdf
DescribeFatLogs
调用 DescribeFatLogs 接口查询目标 Redis 实例在指定时间内的 Server 节点或 Proxy 节点的 Fatlog 日志详情。​
请求类型​
同步请求。​
注意事项​
  • Fatlog 日志阈值固定为 500 KB,即返回结果数据量超过 500 KB 的查询语句才会被记录在 Fatlog 日志中。​
  • 仅支持查看最近 3 天内的 Fatlog 日志详情。更多详情,请参见查询 Fatlog。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
redis-cn02sg5o56sbs****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。​
NodeIds​
Array of String​
否​
["proxy-redis-cn02sg5o56sbs****-1", "proxy-redis-cn02sg5o56sbs****-0"]​
需要查询 Fatlog 日志的节点 ID。​
说明​
  • 若该参数留空,默认查询目标实例内所有节点的 Fatlog 日志详情。​
  • 支持同时传入多个节点 ID 进行查询。​
  • 您可以调用 DescribeNodeIds 接口查询目标 Redis 实例下所有的节点 ID 信息。​
  • NodeIds的字符串总长度不可以超过 1024 个字节,建议传入的节点数量不超过 8 个。​
PageSize​
Integer​
是​
50​
每页记录数,取值范围为 1~1000。​
QueryStartTime​
String​
否​
2026-03-17T07:10:00Z​
查询开始时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
说明​
若该参数留空,实际查询开始时间默认为当前时间 3 天前的时间。​
例如,当前时间为 2026 年 03 月 04 号 16:30:00,若 QueryStartTime不填,那么实际查询开始时间为 2026 年 03 月 01 号 16:30:00。​
QueryEndTime​
String​
否​
2026-03-17T07:11:00Z​
查询结束时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
说明​
  • 若该参数留空,实际查询结束时间默认为当前时间。​
  • 查询结束时间需晚于查询开始时间。​
Context​
String​
否​
[1658839101000000,69550,0,null]​
Fatlog 日志记录查询结果的上下文,需要加载更多 Fatlog 日志记录时使用。​
说明​
调用 DescribeFatLogs 接口后,您可以根据返回参数 ListOver 的值来确定是否还有未加载的 Fatlog 日志记录:​
  • 若 ListOver 的值为 false,表示还有符合查询条件的 Fatlog 日志记录未加载完,您可以再次调用 DescribeFatLogs 接口,并使用上一次接口调用时返回参数中的 Context 值来查看剩余的 Fatlog 日志记录。​
  • 若 ListOver 的值为 true,表示已加载完全部符合查询条件的 Fatlog 日志记录。​
FatLogType​
String​
否​
proxy​
Fatlog 的类型。取值:​
  • proxy:Proxy 节点。​
  • server:Server 节点。​
说明​
不传值时则不指定 Fatlog 的类型,proxy 和 server 都返回。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Context​
String​
[1658839101000000,69550,0,null]​
Fatlog 日志记录查询结果的上下文,需要加载更多 Fatlog 日志记录时使用。​
FatLogs​
Array of FatLogItem​
请参见返回示例。​
Fatlog 日志详情。​
InstanceId​
String​
redis-cn02sg5o56sbs****​
实例 ID。​
ListOver​
Boolean​
true​
Fatlog 日志内容是否已全部加载。取值范围如下:​
  • true:已全部加载。​
  • false:未全部加载。​
说明​
若 ListOver 返回 false,您可以再次调用 DescribeProxyFatLogs,并在请求参数中传入 Context返回的值,来查询未加载完的 Fatlog 日志详情。​
Total​
Integer​
1​
查询结果总条目数。​
​
FatLogItem​
​
参数​
类型​
示例值​
描述​
ActionType​
String​
Read​
请求类型。取值:​
  • Read:读请求。​
  • Write:写请求。​
ClientAddress​
String​
172.22..:47502​
发起查询请求的客户端地址。​
说明​
Sever 节点的 Fatlog 经过了 Proxy 节点转发,返回的客户端地址中包含了 Proxy 地址。​
ClientName​
String​
​
客户端名称。​
Cmd​
String​
GET bigkey​
执行的语句。​
CmdLength​
String​
614411​
语句长度。单位:Byte。​
ExecutionStartTime​
String​
2026-03-17T07:10:22Z​
Fatlog 查询语句的执行开始时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
InstanceId​
String​
redis-cn02sg5o56sbs****​
实例 ID。​
LogId​
String​
​
日志 ID。​
NodeId​
String​
proxy-redis-redis-cn02sg5o56sbs****-0​
Fatlog 所属的节点 ID。​
​
示例​
请求示例​
​
POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeFatLogs&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"​
],​
"QueryStartTime": "2026-03-17T07:10:00Z",​
"QueryEndTime": "2026-03-17T07:11:00Z",​
"PageSize": 50,​
"FatLogType":"proxy"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeFatLogs",​
"Version": "2020-12-07",​
"Service": "Redis",​
"Region": "cn-beijing"​
},​
"Result": {​
"Context": "[1658839101000000,69550,0,null]",​
"FatLogs": [​
{​
"Cmd": "GET bigkey",​
"NodeId": "proxy-redis-redis-cn02sg5o56sbs****-0",​
"CmdLength": "614411",​
"InstanceId": "redis-cn02sg5o56sbs****",​
"ClientAddress": "172.22.***.***:47502",​
"ExecutionStartTime": "2026-03-17T07:10:22Z"​
}​
],​
"InstanceId": "redis-cn02sg5o56sbs****",​
"ListOver": true,​
"Total": 1,​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.21 14:23:32
这个页面对您有帮助吗?
有用
有用
无用
无用