diag.conn.mqtt.list

Requires Org Admin permission or above.

TR50 Request


                        {
  "cmd": {
    "command": "diag.conn.mqtt.list",
    "params": {
      "offset": 0,
      "limit": 10
    }
  }
}

Request Parameters


Name	Type	Required	Description
offset	Integer		The starting list offset, used for pagination. Defaults to 0 if not specified.
limit	Integer		Limits the number of results returned. Defaults to the maximum configured size.

TR50 Response

If the command is sent successfully a success message and the list of MQTT connections is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "count": 42,
      "result": [
        {
          "clientId": "B5198DFF-0001-YBGV-81DD",
          "clientAddr": "192.168.1.1:33417",
          "connType": "SSL",
          "msgsIn": 42,
          "msgsOut": 42,
          "lastConn": "2014-06-25T14:00:53.545243796Z",
          "lastActivity": "2014-06-25T14:00:53.545243796Z"
        },
        ...
      ]
    }
  }
}

Response Parameters


Name	Type	Description
count	Integer	The total number of MQTT connections.
result	Array	The MQTT connections.

Result Array Parameters


Name	Type	Description
clientId	String	The client identifier.
clientAddr	String	The clients IP address.
connType	String	The connection type.
msgsIn	Integer	The number of incoming messages.
msgsOut	Integer	The number of outgoing messages.
lastConn	String	The last connection timestamp.
lastActivity	String	The last activity timestamp.