全部产品
Search
文档中心

数据库自治服务 DAS:GetRedisAllSession - 获取Redis实例当前会话

更新时间:Oct 17, 2024

调用GetRedisAllSession接口,获取Redis实例当前会话数据。

接口说明

  • 本接口只适用于 Redis 引擎。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
说明 对于 Redis 集群版数据库实例,无法获取使用直连模式产生的会话。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ConsoleContextstring

备用参数。

None
InstanceIdstring

数据库实例 ID。

r-2zemyfd1sh1u2i****

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Dataobject

会话数据。

Sessionsarray<object>

会话信息。

sessionsobject
Addrstring

客户端的地址和端口。

172.16.XX.XX:53458
Agestring

已连接时长,单位为秒(s)。

12
Clientstring

客户端的地址。

172.16.XX.XX
ClientDescstring

客户端别名。

prod ip
Cmdstring

最近一次执行的命令。

PING
Dblong

该客户端正在使用的数据库 ID。

0
Eventsstring

文件描述符事件,取值为:

  • r:客户端套接字在事件 Loop 中可读。
  • w:客户端套接字在事件 Loop 中可写。
r
Fdlong

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

73
Flagsstring

客户端标志,取值如下:

  • A:尽快关闭连接。
  • b:客户端正在等待阻塞事件。
  • c:写入全部回复后将关闭连接。
  • d:受监视的键已被修改,EXEC命令将失败。
  • i:客户端正在等待虚拟机 I/O 操作(已废弃)。
  • M:客户端是主节点。
  • N:未设置特点标志。
  • O:处于监视模式的客户端。
  • r:客户端是只读模式的集群节点。
  • S:客户端是一般模式下的从节点。
  • u:客户端未被阻塞。
  • U:通过 Unix 域套接字连接的客户端。
  • x:客户端正在执行事务。
N
Idlong

客户端 ID。

9080586
Idlelong

空闲时长,单位为秒(s)。

8
Multilong

MULTI/EXEC上下文中的命令数。

-1
Namestring

客户端名称。

test
NodeIdstring

节点 ID。

r-2zemyfd1sh1u2i****-proxy-14#1679****
Obllong

输出固定缓冲区大小,单位为字节(Byte)。

0
Olllong

输出列表包含的对象数量。

0
Omemlong

输出缓冲区大小,单位为字节(Byte)。

0
Psublong

模式匹配的订阅数量。

0
Qbuflong

输入缓冲区大小,单位为字节(Byte)。

0
QbufFreelong

输入缓冲区剩余大小,单位为字节(Byte)。

0
Sublong

频道订阅数量。

0
SourceStatsarray<object>

访问来源统计数据。

sourceStatsobject
Countstring

该访问来源的会话总数。

1
Idsarray

客户端 ID 数据。

idslong

客户端 ID。

9080586
Keystring

访问来源。

172.16.XX.XX
Timestamplong

获取数据库会话数据的时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1660100753556
Totallong

会话总数。

2
Messagestring

请求返回的消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

40C6E9AF-6C23-5614-AA83-34344CC6****
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Data": {
    "Sessions": [
      {
        "Addr": "172.16.XX.XX:53458",
        "Age": "12",
        "Client": "172.16.XX.XX",
        "ClientDesc": "prod ip",
        "Cmd": "PING",
        "Db": 0,
        "Events": "r",
        "Fd": 73,
        "Flags": "N",
        "Id": 9080586,
        "Idle": 8,
        "Multi": -1,
        "Name": "test",
        "NodeId": "r-2zemyfd1sh1u2i****-proxy-14#1679****",
        "Obl": 0,
        "Oll": 0,
        "Omem": 0,
        "Psub": 0,
        "Qbuf": 0,
        "QbufFree": 0,
        "Sub": 0
      }
    ],
    "SourceStats": [
      {
        "Count": "1",
        "Ids": [
          9080586
        ],
        "Key": "172.16.XX.XX"
      }
    ],
    "Timestamp": 1660100753556,
    "Total": 2
  },
  "Message": "Successful",
  "RequestId": "40C6E9AF-6C23-5614-AA83-34344CC6****",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史