调用 DescribeClientSessionSnapshot 接口查询实例在指定时间窗口内的客户端会话快照。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

请求参数包含实例 ID、查询时间范围、分页信息、排序条件和过滤条件。

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn02sg5o56sbs****	Redis 实例 ID，用于指定要查询客户端会话快照的实例。不能为空，服务端会校验实例存在性和账号归属。
QueryStartTime	String	是	2022-07-26T12:37:54Z	查询开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
QueryEndTime	String	是	2022-07-26T12:38:54Z	查询结束时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明 QueryStartTime 和 QueryEndTime 所限定的时间跨度不得超过 5 分钟。
PageSize	Integer	否	10	每页记录数。取值范围为 1～1000，默认值为 500。
Context	String	否	1658839101000000,69550,0,null	分页上下文。首次查询可为空；查询下一页时传入上一次响应中的 Context。为空或不传时表示首次分页查询。
OrderType	String	否	AES	排序方向。可为空；非空时必须为服务端支持的排序类型。无默认值，通常与 OrderBy 配合使用。
OrderBy	String	否	ClientAddr	排序字段。可为空；非空时必须为 ClientSessionOrderBy 支持的枚举值，如 ClientAddr、SessionAge、SessionIdle、SessionFlags、SessionDb、SessionSub、SessionPsub、SessionMulti 或 SessionCmd。
Filter	Array of ClientSessionFilter	否	请参见请求示例。	过滤条件列表，用于按客户端连接属性筛选会话快照。不传或为空列表时不过滤。每个过滤项包含 FilterKey 和 FilterValue。

ClientSessionFilter

参数	类型	是否必选	示例值	描述
FilterKey	String	否	ClientAddr	过滤条件的 Key。取值： ClientId：按 Redis client session ID 过滤。 ClientAddr：按客户端地址和端口过滤。 NodeId：按 Proxy 节点 ID 过滤。
FilterValue	String	否	192.168.1.100:12345	过滤条件的 Key 对应的 Value.

返回参数

返回结果包含命中总数、实例 ID、分页上下文、是否加载完成以及客户端会话快照列表。

参数	类型	示例值	描述
Total	Integer	1	查询命中的客户端会话总条目数，取值为非负整数。
InstanceId	String	redis-cn02sg5o56sbs****	本次查询对应的 Redis 实例 ID，与请求中的 InstanceId 对应。
Context	String	1658839101000000,69550,0,null	下一次分页查询使用的上下文游标。没有更多数据时通常为空字符串。
ListOver	Boolean	true	分页结束标识。取值： true：表示没有更多数据； false：表示可能还能继续分页。
SessionList	Array of ClientSessionItem	请参见返回示例。	客户端会话快照列表。

ClientSessionItem

参数	类型	示例值	描述
NodeId	String	proxy-redis-cn02sg5o56sbs****-0	Proxy 节点 ID，表示连接落在哪个 Proxy 节点。
ClientId	Long	111222	Redis client session ID。
ClientIp	String	192.168.1.100	客户端 IP 地址。
SessionDb	Long	0	当前连接使用的 Redis DB 编号。
SessionFd	Integer	222333	套接字所使用的文件描述符。
ClientAddr	String	192.168.1.100:12345	客户端的地址和端口，形如 ip:port。
ClientName	String	client-xxx	客户端连接名。可能为空，取决于客户端是否设置名称。
InstanceId	String	redis-cn02sg5o56sbs****	本次查询对应的 Redis 实例 ID，与请求中的 InstanceId 对应。
SessionAge	Long	150	连接已存在时长。单位为秒。通常为非负整数。
SessionCmd	String	info	最近一次执行的命令。
SessionObl	Long	0	输出缓冲区长度。单位为字节。0 表示没有分配输出缓冲区。
SessionOll	Long	100	输出列表包含的对象数量。
SessionSub	Integer	0	已订阅频道数量。
SessionAuth	Integer	1	是否已通过认证的状态标识。
SessionIdle	Long	0	连接空闲时长。单位为秒。通常为非负整数。
SessionOmem	Long	95	输出缓冲区和输出列表占用的总内存。
SessionPsub	Integer	0	已订阅模式的数量。
SessionQbuf	Long	0	查询缓冲区长度。单位为字节。0 表示没有分配查询缓冲区。
SessionFlags	String	0	客户端状态 flag。
SessionMulti	Integer	0	当前事务中已执行的命令数量。
SessionEvents	String	fd-xxx	文件描述符事件信息。
SessionQbufFree	Long	100	查询缓冲区剩余空间。单位为字节。0 表示没有剩余空间。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

缓存数据库 Redis 版