"listMqSessions"
(jsonAction)
Use the "listMqSessions"
action to view a list of sessions that match the "partialClientName"
The "listMqSessions"
action returns a list of all MQ sessions that match the "partialClientName"
. If "partialClientName"
is omitted or set to null
, it returns all MQ sessions, including those created by MQTT and the MQ API.
Request examples
Minimal
{
"api": "mq",
"action": "listMqSessions",
"params": {},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"api": "mq",
"action": "listMqSessions",
"params":
{
"partialClientName": "",
"connectionStatusFilter": [
"disconnected",
"connected",
"connectedTemporarily"
],
"sessionStatusFilter": [
"normal",
"banned",
"hidden",
"inactive"
],
"sessionTypeFilter": [ "mqtt", "mqApi" ],
"healthFilter": [ "healthy", "unhealthy" ],
"unsetHealthMeasures": true,
"sortDescending": "lastConnect|lastDisconnect|clientName|ipAddress",
"sortAscending": "lastConnect|lastDisconnect|clientName|ipAddress",
"labelId": 423,
"label": {
"group": "group name",
"name": "label name"
}
},
"apiVersion": "1.0",
"debug": "max",
"requestId": "optionalUniqueRequestIdFromTheClient",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Use the "listMqSessions"
action to view a list of sessions that match the "partialClientName"
Table 1.
"params"
property summariesProperty | Description | Default | Type | Limits (inclusive) |
---|---|---|---|---|
(optional) specifies which sessions to return from the |
| string |
The "partialClientName"
property is a string that is used to specify which sessions to return from the "listMqSessions"
action.