调用GetRedisAllSession获取Redis实例当前会话_数据库自治服务(DAS)-阿里云帮助中心

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

接口说明

本接口只适用于 Redis 引擎。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

说明对于 Redis 集群版数据库实例，无法获取使用直连模式产生的会话。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
hdm:GetRedisAllSession	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ConsoleContext	string	否	备用参数。	None
InstanceId	string	是	数据库实例 ID。	r-2zemyfd1sh1u2i****

返回参数

名称	类型	描述	示例值
	object
Code	long	返回的状态码。	200
Message	string	请求返回的消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Data	object	会话数据。
Timestamp	long	获取数据库会话数据的时间，格式为 Unix 时间戳，单位为毫秒（ms）。	1660100753556
Total	long	会话总数。	2
Sessions	object []	会话信息。
Sub	long	频道订阅数量。	0
Psub	long	模式匹配的订阅数量。	0
Idle	long	空闲时长，单位为秒（s）。	8
Flags	string	客户端标志，取值如下： A：尽快关闭连接。 b：客户端正在等待阻塞事件。 c：写入全部回复后将关闭连接。 d：受监视的键已被修改，`EXEC`命令将失败。 i：客户端正在等待虚拟机 I/O 操作（已废弃）。 M：客户端是主节点。 N：未设置特点标志。 O：处于监视模式的客户端。 r：客户端是只读模式的集群节点。 S：客户端是一般模式下的从节点。 u：客户端未被阻塞。 U：通过 Unix 域套接字连接的客户端。 x：客户端正在执行事务。	N
Oll	long	输出列表包含的对象数量。	0
QbufFree	long	输入缓冲区剩余大小，单位为字节（Byte）。	0
Multi	long	`MULTI`/`EXEC`上下文中的命令数。	-1
Omem	long	输出缓冲区大小，单位为字节（Byte）。	0
Qbuf	long	输入缓冲区大小，单位为字节（Byte）。	0
Name	string	客户端名称。	test
Obl	long	输出固定缓冲区大小，单位为字节（Byte）。	0
Client	string	客户端的地址。	172.16.XX.XX
Cmd	string	最近一次执行的命令。	PING
Id	long	客户端 ID。	9080586
Addr	string	客户端的地址和端口。	172.16.XX.XX:53458
NodeId	string	节点 ID。	r-2zemyfd1sh1u2i**-proxy-14#1679**
Age	string	已连接时长，单位为秒（s）。	12
Db	long	该客户端正在使用的数据库 ID。	0
Events	string	文件描述符事件，取值为： r：客户端套接字在事件 Loop 中可读。 w：客户端套接字在事件 Loop 中可写。	r
Fd	long	套接字所使用的文件描述符。	73
ClientDesc	string	客户端别名。	prod ip
SourceStats	object []	访问来源统计数据。
Key	string	访问来源。	172.16.XX.XX
Count	string	该访问来源的会话总数。	1
Ids	array	客户端 ID 数据。
	long	客户端 ID。	9080586
RequestId	string	请求 ID。	40C6E9AF-6C23-5614-AA83-34344CC6****
Success	boolean	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史