Skip to main content

"describeBrokerConnections" (JSON Action)

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

{
  "api":        "mq",
  "action":     "describeBrokerConnections",
  "params":     {
    "brokerConnectionNames": [ "MqttBroker1" ]
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

Response examples

Minimal

{
    "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": ""
}

The "describeBrokerConnections" JSON action retrieves information about broker connections, including hostname, port, username, reconnect frequency, connection status, status code, and status message.

API actionsJSON MQ APIJSON Actiondescribe broker connectiondescribeBrokerConnectionJSON actionMQHubbroker connectionsAPIhostnameportreconnect frequencydescribe connections

"params"

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties. See System limits for a comprehensive look at property requirements and limitations.

Table 1. "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

brokerConnectionNames

(optional) contains a list of "brokerConnectionName" strings

[]

array



"brokerConnectionNames"

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.

"result"

Properties summary

Table 2. "result" properties summary

Property

Description

Type

Limits (inclusive)

brokerConnectionNames

contains a list of "brokerConnectionName" strings

array



"brokerConnectionNames"

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.