"describeBrokerConnections"
JSON MQ and Hub "describeBrokerConnections" action returns info about broker connections
The "describeBrokerConnections" action returns all available information about specified broker connections.
Request examples
Minimal request
{
"api": "mq",
"action": "describeBrokerConnections",
"params": {
"brokerConnectionNames": [ "MqttBroker1" ]
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}{
"result": {
"brokerConnectionNames": [
{
"brokerHostname": "https://mqtt.faircom.com/",
"brokerPort": 1883,
"brokerUserName": "",
"reconnectFrequencySeconds": 15,
"isConnected": true,
"statusCode": 9026,
"statusMessage": "Not able to connect thread to MQTT broker"
}
]
},
"requestId": "00000056",
"errorCode": 0,
"errorMessage": ""
}describeBrokerConnections returns all available information about specified broker connections
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Properties summary
"params" properties summaryProperty | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
brokerConnectionNames | contains a list of |
| array |
Properties summary
"result" properties summaryProperty | Description | Type | Limits (inclusive) |
|---|---|---|---|
contains a list of | array |
The "brokerConnectionNames" property is a required array that contains a list of "brokerConnectionName" strings. It defaults to an empty array.
Must contain at least one string.
Each string is the name of a table.
A zero-length string is invalid.
A client should force uniqueness of the items in the array because the server ignores duplicate items.