Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying Session Statistics of an Instance Node
Updated on 2025-07-02 GMT+08:00

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.

URI

GET https://{Endpoint}/v3/{project_id}/redis/nodes/{node_id}/session-statistics

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

node_id

Yes

String

Explanation:

Node ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total_connection_count

Integer

Explanation:

Total client connections.

Values:

N/A

active_connection_count

Integer

Explanation:

Number of active client connections.

Values:

N/A

top_source_ips

Array of objects

Explanation:

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.

Values:

N/A

top_dbs

Array of objects

Explanation:

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.

Values:

N/A

Table 4 SourceTopConnection

Parameter

Type

Description

client_ip

String

Explanation:

Client IP address.

Values:

N/A

connection_count

Integer

Explanation:

Number of client connections.

Values:

N/A

Table 5 TopDbConnection

Parameter

Type

Description

db

String

Explanation:

GeminiDB Redis database ID.

Values:

N/A

connection_count

Integer

Explanation:

Number of client connections.

Values:

N/A

Example Requests

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

Example Responses

Status code: 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 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.