ESD 设备配置查询与修改

Overview

ESD（设备配置分发服务）提供设备配置的查询和修改接口。所有环境使用统一的 sigV2 签名认证，仅 Base URL 不同。

When to Use

• 查询设备在 ESD 配置中心的当前配置
• 修改设备配置（如 webSocket support、timezone、statusLight 等）
• 排查设备消息投递问题（XMPP vs WebSocket 路由）
• 验证 Blade 双写后 ESD MySQL 中的配置值

Quick Reference

环境参考

认证路径对比

签名算法

signature = md5(secret + "accessKey=<accessKey>jsonObject=<jsonObject>")

规则：

1. 将所有参数（排除 signature 本身）按 key 字母序排序
2. 拼接为 key=value 格式（无分隔符）
3. 在前面拼接 secret
4. 对整个字符串做 MD5

API 1: 查询设备当前配置 (getCurrentSetting)

端点: POST /sigV2/profile/app/getCurrentSetting

jsonObject 格式:

{"deviceid":"<设备ID>","token":"<token>"}

完整调用示例:

DEVICE_ID="xxxxS_54f29f143034"
TOKEN="4c873406fa384908a0b0c644d4a4bd05"
SECRET="6mCBWg13tedIsdv8A56P"
ACCESS_KEY="42435117-1e6"
# 根据环境选择 Base URL
BASE_URL="https://psh-esd.closeli.com/lecam"       # HK
# BASE_URL="https://esd.stg.closeli.com/lecam"      # STG

JSON="{\"deviceid\":\"${DEVICE_ID}\",\"token\":\"${TOKEN}\"}"
SIG_STRING="${SECRET}accessKey=${ACCESS_KEY}jsonObject=${JSON}"
SIGNATURE=$(echo -n "$SIG_STRING" | md5sum | awk '{print $1}')

curl -s -X POST "${BASE_URL}/sigV2/profile/app/getCurrentSetting" \
  --data-urlencode "accessKey=${ACCESS_KEY}" \
  --data-urlencode "jsonObject=${JSON}" \
  --data-urlencode "signature=${SIGNATURE}"

成功响应: failflag: "0"，content 字段包含完整设备配置 XML。

API 2: 修改设备配置 (saveSettingByPaths)

端点: POST /sigV2/profile/saveSettingByPaths

jsonObject 格式:

{
  "deviceid": "<设备ID>",
  "token": "<token>",
  "savetype": "3",
  "paths": [
    {
      "path": "profile/general/webSocket",
      "element": "<webSocket support=\"1\"/>"
    }
  ]
}

savetype 说明:

注意: ESD 开启 saveSupportQueueSwitch 时，saveSettingAttrByPaths 会被放入队列异步处理。使用 saveSettingByPaths + savetype=3 可直接写入。

完整调用示例:

DEVICE_ID="xxxxS_54f29f143034"
TOKEN="4c873406fa384908a0b0c644d4a4bd05"
SECRET="6mCBWg13tedIsdv8A56P"
ACCESS_KEY="42435117-1e6"
BASE_URL="https://psh-esd.closeli.com/lecam"

JSON="{\"deviceid\":\"${DEVICE_ID}\",\"token\":\"${TOKEN}\",\"savetype\":\"3\",\"paths\":[{\"path\":\"profile/general/webSocket\",\"element\":\"<webSocket support=\\\"1\\\"/>\"}]}"
SIG_STRING="${SECRET}accessKey=${ACCESS_KEY}jsonObject=${JSON}"
SIGNATURE=$(echo -n "$SIG_STRING" | md5sum | awk '{print $1}')

curl -s -X POST "${BASE_URL}/sigV2/profile/saveSettingByPaths" \
  --data-urlencode "accessKey=${ACCESS_KEY}" \
  --data-urlencode "jsonObject=${JSON}" \
  --data-urlencode "signature=${SIGNATURE}"

成功响应: failflag: "0"

API 3: 版本查询

curl -s https://esd.stg.closeli.com/lecam/version
# 返回: ESD_3.1.0_20260316_B1491_8cbf78e7

Common Mistakes