host URLs:
所有的接口都需要加入sign参数,sign参数的计算方式:
把projectId=xxx&serialNo=zzzz×tamp=1234567890 拼接起来,
然后用AES256 ECB PCK7加密方式, projectSecret作为密钥,得到signature参数的值。
GET mqttInfo
GET /mqttInfo
获取mqtt信息
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| serialNo | query | string | 是 | 设备序列号 |
| timestamp | query | string | 是 | 当前毫秒级时间戳,参与signature签名计算 |
| signature | query | string | 是 | 签名值,见上方sign说明 |
| isSign | query | boolean | 否 | 是否返回签名相关字段,默认false |
说明:projectSecret 不通过URL传递,仅作为 AES256 加密密钥参与 signature 计算。
返回示例
200 Response
{
"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
}
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
{
"code": 200,
"message": "请求成功",
"data": {
"host": "string",
"port": "string",
"clientId": "string",
"username": "string",
"password": "string",
"pubTopic": "string",
"subTopic": "string",
"notifyTopic": "string",
"expire": "integer"
}
}data 字段说明
| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
| host | string | 是 | MQTT服务器地址,格式 mqtt-{projectId前2位}.{区域}.{主域名} |
| port | string | 是 | MQTT端口,默认1883 |
| clientId | string | 是 | 客户端ID,格式 {projectId}&{serialNo} |
| username | string | 是 | MQTT用户名,格式 DEV&DSIG&{projectId}&{serialNo}&{毫秒时间戳},时间戳参与服务端超时校验 |
| password | string | 是 | MQTT密码,对username做HMAC-SHA1签名后取小写 |
| pubTopic | string | 是 | 设备发布主题(上行数据) |
| subTopic | string | 是 | 设备订阅主题(下行数据) |
| notifyTopic | string | 是 | 系统通知主题 |
| expire | number | 是 | username中时间戳有效期(毫秒),对应服务端 xsgee.mqtt.dsig-timeout 配置 |
GET updateOtaUpgrading
GET /board/updateOtaUpgrading
更新设备OTA状态为,正在OTA升级
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET queryConfig
GET /board/queryConfig
查询设备配置
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateConfigFinish
GET /board/updateConfigFinish
更新设备配置状态为,配置成功
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| configVersion | query | string | 否 | 配置版本 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET now
GET /board/now
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| type | query | string | 是 | 返回时间类型,可选值date和timestamp,默认timestamp |
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateLocation
GET /board/updateLocation
更新设备位置
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| longitude | query | string | 是 | 经度 |
| latitude | query | string | 是 | 纬度 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET pushLog
GET /board/pushLog
上传设备日志
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| content | query | string | 否 | 日志内容,长度最大为256字符 |
| level | query | string | 否 | 日志等级 |
| code | query | string | 否 | 自定义日志码 |
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateSwVersion
GET /board/updateSwVersion
更新设备软件版本号
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| swVersion | query | string | 否 | none |
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateConfigFailed
GET /board/updateConfigFailed
更新设备配置状态为,配置失败
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateOtaFailed
GET /board/updateOtaFailed
更新设备OTA状态为,OTA失败
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateOtaFinish
GET /board/updateOtaFinish
更新设备OTA状态为,OTA成功
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| swVersion | query | string | 是 | 软件版本号 |
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateOtaDownloading
GET /board/updateOtaDownloading
更新设备OTA状态为,正在下载固件
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateOtaReceived
GET /board/updateOtaReceived
更新设备OTA状态为,已收到OTA通知
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET queryOta
GET /board/queryOta
查询设备OTA信息
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET queryTags
GET /board/queryTags
查询设备标签
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateProp
GET /board/updateProp
更新设备属性
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| key | query | string | 是 | 需要修改的key |
| value | query | string | 是 | 需要修改key的值 |
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET updateConfigReceived
GET /board/updateConfigReceived
更新设备配置状态为,已收到配置通知。如果设备执行配置时间少于5分钟,可以不用通知小机云已收到通知
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET queryProps
GET /board/queryProps
查询设备属性
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
POST updateProps
POST /board/updateProps
批量更新设备属性
Body 请求参数
{
"rssi": 22,
"capacity": 18,
"location": "116.40154828045652,39.90310373211554"
}请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
| body | body | object | 否 | none |
| » rssi | body | integer | 是 | 信号值:0~31;无卡:-1;无网络:99 |
| » capacity | body | integer | 是 | 电量:0~100,充电状态:101 |
| » location | body | string | 是 | 设备坐标。格式:经度,纬度;例:113.910824,22.575219 |
| » key1 | body | string | 是 | 自定义属性示例,根据业务需求添加或删除 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET deleteProp
GET /board/deleteProp
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| key | query | string | 否 | 需要删除的key |
| projectId | query | string | 是 | 项目ID |
| projectSecret | query | string | 是 | 项目密钥 |
| serialNo | query | string | 是 | 设备序列号 |
| format | query | string | 否 | 返回格式,可选参数text。默认为返回json格式返回 |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
POST deleteProps
POST /board/deleteProps
批量删除设备属性
Body 请求参数
[
"key1",
"key2"
]请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | array[string] | 否 | none |
返回示例
200 Response
{}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
