文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 获取节点会话列表
更新时间：2024-03-29 GMT+08:00
查看PDF
分享

获取节点会话列表

功能介绍

获取节点会话列表。

接口约束

该接口支持如下数据库实例： GeminiDB Redis。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://{Endpoint}/v3/{project_id}/redis/nodes/{node_id}/sessions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

node_id

是

String

节点ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。取值大于或等于0。不传该参数时，查询偏移量默认为0，表示从最新创建的实例节点连接开始查询。

limit

否

Integer

分页查询页数。不传该参数时，默认每页50条实例节点连接信息，最大100条。

addr_prefix

否

String

用户端地址前缀匹配字符串。完整的地址由ip和端口号组成。不传默认查询所有。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

X-Language

否

String

语言。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

sessions

Array of objects

实例会话详细信息列表。详情请参考表5。

total_count

Integer

符合查询条件的总会话数。
表5 InstanceSession

参数

参数类型

描述

addr

String

客户端IP地址和端口。

id

String

客户端ID。

name

String

客户端名称（由CLIENT SETNAME命令设定）。

cmd

String

最近一次执行的命令。

age

String

客户端连接建立时长（单位：秒）。

idle

String

客户端连接空闲时长（单位：秒）。

db

String

当前访问的子库DB ID。

fd

String

socket套接字所使用的文件描述符。

sub

String

pub/sub已订阅的频道数量。

psub

String

pub/sub批量订阅的频道数量。

multi

String

单次MULTI/EXEC事务中包含的命令数量。

请求示例

GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/nodes/784b3fb7bac14bc490659950dd4f022fno12/sessions?offset=0&limit=20&addr_prefix=192.0.0.1:80

响应示例

状态码： 200

Success

{ 
  "total_count" : 100, 
  "sessions" : [ { 
    "addr" : "127.0.0.1:8080", 
    "id" : "254487", 
    "name" : "cli", 
    "cmd" : "get", 
    "age" : "8888581", 
    "idle" : "8888581", 
    "db" : "0", 
    "fd" : "1311", 
    "sub" : "0", 
    "psub" : "0", 
    "multi" : "-1" 
  } ] 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档