Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying Session Statistics of an Instance Node

Updated on 2025-12-04 GMT+08:00

View PDF

Querying Session Statistics of an Instance Node

Function

This API is used to query session statistics of an instance node.

Constraints

This API supports GeminiDB Redis instances.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
node_id	Yes	String	Definition Node ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_connection_count	Integer	Definition Total client connections. Range N/A
active_connection_count	Integer	Definition Number of active client connections. Range N/A
top_source_ips	Array of objects	Definition Top ten clients with the most connections. Total connected clients and their IP addresses are displayed and ordered based on sessions. For details, see Table 4. Range N/A
top_dbs	Array of objects	Definition Top ten databases with the most connections. Total connected clients and their IP addresses are displayed and ordered based on sessions. For details, see Table 5. Range N/A

**Table 4** SourceTopConnection
Parameter	Type	Description
client_ip	String	Definition Client IP address. Range N/A
connection_count	Integer	Definition Number of client connections. Range N/A

**Table 5** TopDbConnection
Parameter	Type	Description
db	String	Definition GeminiDB Redis database ID. Range N/A
connection_count	Integer	Definition Number of client connections. Range N/A

Example Requests

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

Example Responses

Status code: 200

Successful response

{ 
  "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 
  } ] 
}