Querying Session Statistics of an Instance Node_Instances_APIs v3_API Reference

Function

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

Constraints

This API supports GeminiDB Redis instances.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
node_id	Yes	String	Node ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_connection_count	Integer	Total client connections.
active_connection_count	Integer	Number of active client connections.
top_source_ips	Array of objects	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.
top_dbs	Array of objects	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.

**Table 4** SourceTopConnection
Parameter	Type	Description
client_ip	String	Client IP address.
connection_count	Integer	Number of client connections.

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

Example Request

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

Example Response

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

See Status Codes.

Error Codes

See Error Codes.

Querying Session Statistics of an Instance Node