跳到主要内容

save_mqtt_client_config 保存MQTT客户端配置

POST /api/v1/net_manage/save_mqtt_client_config​

描述​

保存MQTT客户端配置，如果在启用MQTT客户端的情况下修改了配置，需要关闭再开启客户端，新配置才能生效。

访问权限​

具备以下权限：

net_manage:save_mqtt_client_config

请求参数​

请求参数如下：

{
  "enableMqttClient": "enable"|"disable",
  "clientId": string,
  "serverIp": string,
  "serverPort": number,
  "QOS": "AtMostOnce"|"AtLeastOnce"|"ExactlyOnce",
  "timeout": number
}
提示
  • 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超时时间

请求示例：

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

响应结果​

请求返回的HTTP状态码为200

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

正确结果示例：

{
  "success": true
}

错误码​

错误码说明错误信息显示类型
40007请求参数格式错误error.request.format2
40007启动MQTT客户端功能不能为空enable.mqtt.client.can.not.be.empty2
40007启动MQTT客户端的值必须是enable或disableenable.mqtt.client.must.be.enable.or.disable2
40007MQTT客户端ID不能为空client.id.can.not.be.empty2
40007MQTT服务器ID长度必须在1-64个字符之间client.id.length.invalid2
40007MQTT服务器IP不能为空server.ip.can.not.be.empty2
40007MQTT服务器IP长度必须在1-64个字符之间server.ip.length.invalid2
40007MQTT服务器端口不能为空server.port.can.not.be.empty2
40007MQTT服务器端口长度必须在1-65535之间server.port.must.be.1.to.655352
40007QOS不能为空qos.can.not.be.empty2
40007QOS取值错误qos.value.invalid2
40007MQTT超时时间不能为空timeout.can.not.be.empty2
40007MQTT超时时间长度必须在1-600之间timeout.must.be.1.to.6002
40007保存配置异常error.saving.config2