Skip to main content

"describeBrokerConnections"

The "describeBrokerConnection" action returns all available information about specified broker connections in FairCom Edge

Abstract

describeBrokerConnections returns all available information about specified broker connections.

The "describeBrokerConnections" action returns all available information about specified broker connections.

Request examples

Minimal request example

{
  "api":        "mq",
  "apiVersion": "1.0",
  "authToken":  "anAuthorizationTokenFromTheServer",
  "requestId":  "00000001",
  "action":     "describeBrokerConnections",
  "params":     {
    "brokerConnectionNames": [ "MqttBroker1" ]
  }
}

Response examples

Minimal response example

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

"params"

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Properties summary

Table 1. "params" properties summary

Property

Description

Default

Type

Limits (inclusive)

brokerConnectionNames

contains a list of "brokerConnectionName" strings

[]

array



"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.

Things to know:

  • 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.