"describeTopics" (jsonAction)
JSON MQ "describeTopics" action returns info about MQTT topics
The "describeTopics" action returns all available information about specified MQTT topics.
Request examples
Minimal
{
"api": "mq",
"apiVersion": "1.0",
"action": "describeTopics",
"params": {
"topics": [
"test/topic1"
]
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"result": {
"data": [
{
"name": "test/topic1",
"creationTime": "2024-02-01T23:47:45.814",
"messageCount": 2,
"lastMessageTime": "2024-02-01T23:47:51.716",
"averageMessagesPerMinute": 0,
"averageMessagesPerHour": 0,
"averageMessagesPerDay": 0,
"subscriberList": [
{
"topicExpression": "#",
"connectionList": [
{
"connection": {
"clientId": "mqtt-explorer-001",
"ipaddress": "127.0.0.1",
"port": 35646,
"mqttProtocol": 4,
"keepAliveSeconds": 60,
"status": "Connected with clean flag = 1",
"connectionTime": "2024-01-31T17:31:19"
},
"qos": 0
}
]
},
{
"topicExpression": "test/#",
"connectionList": [
{
"connection": {
"clientId": "NodeREDSecure",
"ipaddress": "127.0.0.1",
"port": 36115,
"mqttProtocol": 4,
"keepAliveSeconds": 60,
"status": "Connected with clean flag = 1",
"connectionTime": "2024-01-31T17:31:30"
},
"qos": 1
}
]
}
],
"persistence": {
"topic": "test/topic1",
"databaseConnectionString": "FAIRCOMS",
"databaseUserName": "admin",
"databaseName": "faircom",
"tableName": "mqtt_msg_test_topic1",
"ownerName": "admin",
"threads": 1,
"tableAutoTimeStamp": true,
"tableAutoTimeStampIndex": true,
"tableReplicationReady": true,
"retentionPolicy": "autoPurge",
"retentionUnit": "week",
"retentionPeriod": 4,
"storeAndForward": true,
"maxDeliveryRatePerSecond": 0,
"newSubscriberDeliveryMode": "default",
"newSubscriberMaxDeliveredMessages": 0,
"retrySeconds": 20,
"outputPayloadField": "source_payload",
"label": {
"group": "group name",
"name": "label name"
}
}
}
]
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
The describeTopics action returns all available information about specified MQTT topics
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Table 1.
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
topics | (optional) contains |
| array |
Properties summary
Table 2.
"result" properties summaryProperty | Description | Type | Limits (inclusive) |
|---|---|---|---|
data | (optional) specifies an array or object that the server returns, such as records returned by a query. It is always included in a response but contains an empty array when no results are available. It is an empty array when there are no results available | array | Its contents are determined by the action |