Get Connection Information

Get current server connection statistics including connection count and user distribution

GET /connz

Try it

cURL

curl -X GET "http://localhost:5001/connz?offset=0&limit=50&subs=1"

Success Response

{
  "now": "2024-01-15T10:30:00Z",
  "num_connections": 1250,
  "total": 1250,
  "offset": 0,
  "limit": 50,
  "connections": [
    {
      "cid": 12345,
      "uid": "user123",
      "ip": "192.168.1.100",
      "port": 54321,
      "start": "2024-01-15T09:15:30Z",
      "last_activity": "2024-01-15T10:29:45Z",
      "uptime": "1h14m15s",
      "idle": "15s",
      "pending_bytes": 0,
      "in_msgs": 156,
      "out_msgs": 203,
      "in_bytes": 15680,
      "out_bytes": 25440,
      "subscriptions": 8,
      "device_flag": 1,
      "device_level": 1,
      "version": "1.0.0"
    }
  ]
}

Overview

Get current server connection statistics, including connection count, user distribution and other monitoring data.

Query Parameters

offset · integer · default: 0

Offset for pagination

limit · integer · default: 20

Limit for pagination

subs · integer · default: 0

Whether to include subscription information

• 0 - Do not include subscription information
• 1 - Include subscription information

cURL

curl -X GET "http://localhost:5001/connz?offset=0&limit=50&subs=1"

Success Response

{
  "now": "2024-01-15T10:30:00Z",
  "num_connections": 1250,
  "total": 1250,
  "offset": 0,
  "limit": 50,
  "connections": [
    {
      "cid": 12345,
      "uid": "user123",
      "ip": "192.168.1.100",
      "port": 54321,
      "start": "2024-01-15T09:15:30Z",
      "last_activity": "2024-01-15T10:29:45Z",
      "uptime": "1h14m15s",
      "idle": "15s",
      "pending_bytes": 0,
      "in_msgs": 156,
      "out_msgs": 203,
      "in_bytes": 15680,
      "out_bytes": 25440,
      "subscriptions": 8,
      "device_flag": 1,
      "device_level": 1,
      "version": "1.0.0"
    }
  ]
}

Response Fields

now · string · required

Current server time (ISO 8601 format)

num_connections · integer · required

Current number of connections

total · integer · required

Total number of connections

offset · integer · required

Current offset

limit · integer · required

Current limit

connections · array · required

Connection details list

Show connections fields

connections[].cid · integer

Connection ID

connections[].uid · string

User ID

connections[].ip · string

Client IP address

connections[].port · integer

Client port

connections[].start · string

Connection start time

connections[].last_activity · string

Last activity time

connections[].uptime · string

Connection duration

connections[].idle · string

Idle time

connections[].pending_bytes · integer

Pending bytes to send

connections[].in_msgs · integer

Number of received messages

connections[].out_msgs · integer

Number of sent messages

connections[].in_bytes · integer

Number of received bytes

connections[].out_bytes · integer

Number of sent bytes

connections[].subscriptions · integer

Number of subscriptions

connections[].device_flag · integer

Device flag

connections[].device_level · integer

Device level

connections[].version · string

Client version

Status Codes

Status Code	Description
200	Successfully retrieved connection information
500	Internal server error

Best Practices

1. Paginated Queries: Use pagination for large numbers of connections to avoid performance issues
2. Regular Monitoring: Set reasonable monitoring intervals, avoid excessive frequency
3. Alert Mechanisms: Set alerts for key metrics like connection count and activity
4. Data Export: Support export and analysis of connection data
5. Performance Optimization: Monitor connection performance metrics to identify issues promptly
6. Security Monitoring: Pay attention to connections from abnormal IPs