Skip to main content

get_mqtt_client_config 查询MQTT客户端配置

POST /api/v1/net_manage/get_mqtt_client_config​

描述​

查询MQTT客户端配置。

访问权限​

具备以下权限：

net_manage:get_mqtt_client_config

请求参数​

请求参数如下：

{}

无参数，必须传递空对象。

请求示例：

{}

响应结果​

请求返回的HTTP状态码为200

{
  "success": true|false,
  "data"?: {
    "enableMqttClient": "enable"|"disable",
    "clientId": string,
    "serverIp": string,
    "serverPort": number,
    "QOS": "AtMostOnce"|"AtLeastOnce"|"ExactlyOnce",
    "timeout": number
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
tip
  • enableMqttClient: 启用MQTT客户端功能，enable表示启用，disable表示不启用
  • clientId: MQTT客户端ID
  • serverIp: MQTT服务器IP
  • serverPort: MQTT服务器端口
  • QOS: MQTT QOS等级
    • AtMostOnce: 最多一次，对应QOS等级0
    • AtLeastOnce: 至少一次，对应QOS等级1
    • ExactlyOnce: exactly once,对应QOS等级2
  • timeout: MQTT超时时间

正确结果示例：

{
  "success": true,
  "data": {
    "enableMqttClient": "disable",
    "clientId": "Coolshark",
    "serverIp": "192.168.188.25",
    "serverPort": 1883,
    "QOS": "AtMostOnce",
    "timeout": 30
  }
}

响应结果​

请求返回的HTTP状态码为200

{
  "success": true|false,
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

正确结果示例：

{
  "success": true
}

错误码​

错误码说明错误信息显示类型
40007加载配置文件失败error.read.config2