host URLs:

http://dc-api.cn-shanghai.xsgee.com/device-center/board

GET mqttInfo

GET /mqttInfo

获取mqtt信息

请求参数

名称	位置	类型	必选	说明
projectId	query	string	是	项目ID
projectSecret	query	string	是	项目密钥
serialNo	query	string	是	设备序列号
format	query	string	否	返回格式，可选参数text。默认为返回json格式返回

返回示例

200 Response

json

{}

返回结果

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

返回数据结构

GET updateOtaUpgrading

GET /board/updateOtaUpgrading

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

请求参数

名称	位置	类型	必选	说明
projectId	query	string	是	项目ID
projectSecret	query	string	是	项目密钥
serialNo	query	string	是	设备序列号
format	query	string	否	返回格式，可选参数text。默认为返回json格式返回

返回示例

200 Response

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

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

返回数据结构

GET updateConfigFinish

GET /board/updateConfigFinish

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

请求参数

名称	位置	类型	必选	说明
configVersion	query	string	否	配置版本

返回示例

200 Response

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

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

返回数据结构

GET updateLocation

GET /board/updateLocation

更新设备位置

请求参数

名称	位置	类型	必选	说明
longitude	query	string	是	经度
latitude	query	string	是	纬度

返回示例

200 Response

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

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

返回数据结构

GET updateConfigReceived

GET /board/updateConfigReceived

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

返回示例

200 Response

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

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

返回数据结构

POST updateProps

POST /board/updateProps

批量更新设备属性

Body 请求参数

json

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

json

{}

返回结果

状态码	状态码含义	说明	数据模型
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

json

{}

返回结果

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

返回数据结构

POST deleteProps

POST /board/deleteProps

批量删除设备属性

Body 请求参数

json

[
  "key1",
  "key2"
]

请求参数

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

返回示例

200 Response

json

{}

返回结果

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

GET mqttInfo ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateOtaUpgrading ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET queryConfig ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateConfigFinish ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET now ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateLocation ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET pushLog ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateSwVersion ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateConfigFailed ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateOtaFailed ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateOtaFinish ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateOtaDownloading ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateOtaReceived ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET queryOta ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET queryTags ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateProp ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET updateConfigReceived ​

返回结果 ​

返回数据结构 ​

GET queryProps ​

请求参数 ​

返回结果 ​

返回数据结构 ​

POST updateProps ​

请求参数 ​

返回结果 ​

返回数据结构 ​

GET deleteProp ​

请求参数 ​

返回结果 ​

返回数据结构 ​

POST deleteProps ​

GET mqttInfo

请求参数

返回结果

返回数据结构

GET updateOtaUpgrading

请求参数

返回结果

返回数据结构

GET queryConfig

请求参数

返回结果

返回数据结构

GET updateConfigFinish

请求参数

返回结果

返回数据结构

GET now

请求参数

返回结果

返回数据结构

GET updateLocation

请求参数

返回结果

返回数据结构

GET pushLog

请求参数

返回结果

返回数据结构

GET updateSwVersion

请求参数

返回结果

返回数据结构

GET updateConfigFailed

请求参数

返回结果

返回数据结构

GET updateOtaFailed

请求参数

返回结果

返回数据结构

GET updateOtaFinish

请求参数

返回结果

返回数据结构

GET updateOtaDownloading

请求参数

返回结果

返回数据结构

GET updateOtaReceived

请求参数

返回结果

返回数据结构

GET queryOta

请求参数

返回结果

返回数据结构

GET queryTags

请求参数

返回结果

返回数据结构

GET updateProp

请求参数

返回结果

返回数据结构

GET updateConfigReceived

返回结果

返回数据结构

GET queryProps

请求参数

返回结果

返回数据结构

POST updateProps

请求参数

返回结果

返回数据结构

GET deleteProp

请求参数

返回结果

返回数据结构

POST deleteProps