文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 实例管理/ 查询实例节点会话统计信息 - QueryingSessionStatisticsofanInstanceNode
更新时间:2025-11-26 GMT+08:00
分享

查询实例节点会话统计信息 - QueryingSessionStatisticsofanInstanceNode

功能介绍

查询实例节点会话统计信息。

接口约束

该接口支持如下数据库实例: 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}/session-statistics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

node_id

String

参数解释:

节点ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total_connection_count

Integer

参数解释:

总客户端连接数。

取值范围:

不涉及。

active_connection_count

Integer

参数解释:

活跃客户端连接数。

取值范围:

不涉及。

top_source_ips

Array of objects

参数解释:

节点连接的各个客户端连接数汇总,从大到小取前十个,最多十个,展示客户端的ip地址和连接总数。详情请参考表4

取值范围:

不涉及。

top_dbs

Array of objects

参数解释:

节点各数据库连接的客户端的ip和该ip连接节点的连接数,按连接数从高到低取前十个,最多十个。详情请参考表5

取值范围:

不涉及。

表4 SourceTopConnection

参数

参数类型

描述

client_ip

String

参数解释:

客户端ip地址。

取值范围:

不涉及。

connection_count

Integer

参数解释:

客户端连接数。

取值范围:

不涉及。

表5 TopDbConnection

参数

参数类型

描述

db

String

参数解释:

redis数据库id。

取值范围:

不涉及。

connection_count

Integer

参数解释:

客户端连接数。

取值范围:

不涉及。

请求示例

GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/nodes/784b3fb7bac14bc490659950dd4f022fno12/session-statistics

响应示例

状态码: 200

Success

{ 
  "total_connection_count" : 10, 
  "active_connection_count" : 5, 
  "top_source_ips" : [ { 
    "client_ip" : "127.0.0.1", 
    "connection_count" : 10 
  }, { 
    "client_ip" : "192.10.14.1", 
    "connection_count" : 9 
  } ], 
  "top_dbs" : [ { 
    "db" : "12", 
    "connection_count" : 10 
  }, { 
    "db" : "14", 
    "connection_count" : 8 
  } ] 
}

状态码

请参见状态码

错误码

请参见错误码

相关文档