获取节点会话列表 - ObtainingSessionsofaNode
功能介绍
获取节点会话列表。
接口约束
该接口支持如下数据库实例： GeminiDB Redis。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:listSession
List
instance *
- g:ResourceTag/<tag-key>
- g:EnterpriseProjectId
nosql:session:list
-
URI
GET /v3/{project_id}/redis/nodes/{node_id}/sessions
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
node_id | 是 | String | 参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Integer | 参数解释： 索引位置，偏移量。 约束限制： 不涉及。 取值范围： 大于或等于0。 默认取值： 默认为0，表示从最新创建的实例节点连接开始查询。 |
limit | 否 | Integer | 参数解释： 分页查询页数。 约束限制： 最大100条。 取值范围： 1-100。 默认取值： 不传该参数时，默认每页50条实例节点连接信息。 |
addr_prefix | 否 | String | 参数解释： 用户端地址前缀匹配字符串。约束限制： 完整的地址由ip和端口号组成。 取值范围： 不涉及。 默认取值： 不传则默认查询所有。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
X-Language | 否 | String | 参数解释： 语言。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
sessions | Array of objects | 参数解释： 实例会话详细信息列表。详情请参考表5。 取值范围： 不涉及。 |
total_count | Integer | 参数解释： 符合查询条件的总会话数。 取值范围： 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
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"
} ]
} 状态码
请参见状态码。
错误码
请参见错误码。
