Skip to content

host URLs:

所有的接口都需要加入sign参数,sign参数的计算方式:

把projectId=xxx&serialNo=zzzz&timestamp=1234567890 拼接起来,

然后用AES256 ECB PCK7加密方式, projectSecret作为密钥,得到signature参数的值。

http://dc-api.cn-shanghai.xsgee.com/device-center/board-v2/mqttInfo?projectId=10089e85c3909bc5dcb7&serialNo=10003B0108A4&timestamp=1769743247000&signature=I%2FWegxpMZtc7tJFq2sJTPgf2Map3glazldIp5mkwlwCHXCvPVpeZcUs6j4Dsd67365h49ijCZEEZR4L4aUHPU1g6E%2FLRyPIr8nDuEbEmLYU%3D

GET mqttInfo ​

GET /mqttInfo

获取mqtt信息

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
serialNoquerystring是设备序列号
timestampquerystring是当前毫秒级时间戳,参与signature签名计算
signaturequerystring是签名值,见上方sign说明
isSignqueryboolean否是否返回签名相关字段,默认false

说明:projectSecret 不通过URL传递,仅作为 AES256 加密密钥参与 signature 计算。

返回示例

200 Response

json
{
  "code": 200,
  "message": "请求成功",
  "data": {
    "host": "mqtt-10.cn-shanghai.xsgee.com",
    "port": "1883",
    "clientId": "10089e85c3909bc5dcb7&10003B0108A4",
    "username": "DEV&DSIG&10089e85c3909bc5dcb7&10003B0108A4&1769743247000",
    "password": "d0b64f34e4c5aa1e5096c5a911b4aa2c4c7f0e2f",
    "pubTopic": "/10089e85c3909bc5dcb7/10003B0108A4/user/update",
    "subTopic": "/10089e85c3909bc5dcb7/10003B0108A4/user/get",
    "notifyTopic": "/10089e85c3909bc5dcb7/10003B0108A4/user/notify",
    "expire": 3600000
  }
}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

json
{
  "code": 200,
  "message": "请求成功",
  "data": {
    "host": "string",
    "port": "string",
    "clientId": "string",
    "username": "string",
    "password": "string",
    "pubTopic": "string",
    "subTopic": "string",
    "notifyTopic": "string",
    "expire": "integer"
  }
}

data 字段说明 ​

字段类型必选说明
hoststring是MQTT服务器地址,格式 mqtt-{projectId前2位}.{区域}.{主域名}
portstring是MQTT端口,默认1883
clientIdstring是客户端ID,格式 {projectId}&{serialNo}
usernamestring是MQTT用户名,格式 DEV&DSIG&{projectId}&{serialNo}&{毫秒时间戳},时间戳参与服务端超时校验
passwordstring是MQTT密码,对username做HMAC-SHA1签名后取小写
pubTopicstring是设备发布主题(上行数据)
subTopicstring是设备订阅主题(下行数据)
notifyTopicstring是系统通知主题
expirenumber是username中时间戳有效期(毫秒),对应服务端 xsgee.mqtt.dsig-timeout 配置

GET updateOtaUpgrading ​

GET /board/updateOtaUpgrading

更新设备OTA状态为,正在OTA升级

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET queryConfig ​

GET /board/queryConfig

查询设备配置

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateConfigFinish ​

GET /board/updateConfigFinish

更新设备配置状态为,配置成功

请求参数 ​

名称位置类型必选说明
configVersionquerystring否配置版本

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET now ​

GET /board/now

请求参数 ​

名称位置类型必选说明
typequerystring是返回时间类型,可选值date和timestamp,默认timestamp
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateLocation ​

GET /board/updateLocation

更新设备位置

请求参数 ​

名称位置类型必选说明
longitudequerystring是经度
latitudequerystring是纬度

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET pushLog ​

GET /board/pushLog

上传设备日志

请求参数 ​

名称位置类型必选说明
contentquerystring否日志内容,长度最大为256字符
levelquerystring否日志等级
codequerystring否自定义日志码
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateSwVersion ​

GET /board/updateSwVersion

更新设备软件版本号

请求参数 ​

名称位置类型必选说明
swVersionquerystring否none
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateConfigFailed ​

GET /board/updateConfigFailed

更新设备配置状态为,配置失败

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateOtaFailed ​

GET /board/updateOtaFailed

更新设备OTA状态为,OTA失败

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateOtaFinish ​

GET /board/updateOtaFinish

更新设备OTA状态为,OTA成功

请求参数 ​

名称位置类型必选说明
swVersionquerystring是软件版本号
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateOtaDownloading ​

GET /board/updateOtaDownloading

更新设备OTA状态为,正在下载固件

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateOtaReceived ​

GET /board/updateOtaReceived

更新设备OTA状态为,已收到OTA通知

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET queryOta ​

GET /board/queryOta

查询设备OTA信息

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET queryTags ​

GET /board/queryTags

查询设备标签

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateProp ​

GET /board/updateProp

更新设备属性

请求参数 ​

名称位置类型必选说明
keyquerystring是需要修改的key
valuequerystring是需要修改key的值
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET updateConfigReceived ​

GET /board/updateConfigReceived

更新设备配置状态为,已收到配置通知。如果设备执行配置时间少于5分钟,可以不用通知小机云已收到通知

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET queryProps ​

GET /board/queryProps

查询设备属性

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

POST updateProps ​

POST /board/updateProps

批量更新设备属性

Body 请求参数

json
{
  "rssi": 22,
  "capacity": 18,
  "location": "116.40154828045652,39.90310373211554"
}

请求参数 ​

名称位置类型必选说明
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回
bodybodyobject否none
» rssibodyinteger是信号值:0~31;无卡:-1;无网络:99
» capacitybodyinteger是电量:0~100,充电状态:101
» locationbodystring是设备坐标。格式:经度,纬度;例:113.910824,22.575219
» key1bodystring是自定义属性示例,根据业务需求添加或删除

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

GET deleteProp ​

GET /board/deleteProp

请求参数 ​

名称位置类型必选说明
keyquerystring否需要删除的key
projectIdquerystring是项目ID
projectSecretquerystring是项目密钥
serialNoquerystring是设备序列号
formatquerystring否返回格式,可选参数text。默认为返回json格式返回

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

POST deleteProps ​

POST /board/deleteProps

批量删除设备属性

Body 请求参数

json
[
  "key1",
  "key2"
]

请求参数 ​

名称位置类型必选说明
bodybodyarray[string]否none

返回示例

200 Response

json
{}

返回结果 ​

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构 ​

数据模型 ​