批量查询设备影子

基本信息

Path： /v1/shadows/:instanceId/shadow/batch

Method： POST

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId

Body

名称	类型	是否必须	默认值	备注	其他信息
devices	object	必须
├─ productKey	string	必须
├─ deviceName	string	必须
├─ bindName	string	非必须		默认值为MAIN

返回数据

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须
├─ productKey	string	必须
├─ deviceName	string	必须
├─ bindName	string	非必须
├─ shadowSnapshot	object	必须
├─ reported	object	必须
├─ desired	object	必须
├─ lastUpdated	object	必须

更新desired

基本信息

Path： /v1/shadows/:instanceId/:productKey/:deviceName/desired

Method： PUT

接口描述： 请求参数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
instanceId
productKey
deviceName

Query

参数名称	是否必须	示例	备注
bindName	否

Body

名称	类型	是否必须	默认值	备注	其他信息
desired	object	必须		类型： Map <String, Object>

返回数据

无

查询设备影子 （裸影子）

基本信息

Path： /v1/shadows/:instanceId/:productKey/:deviceName/shadow

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey
deviceName

Query

参数名称	是否必须	示例	备注
bindName	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
reported	object	必须
desired	object	必须
lastUpdated	object	必须

设备影子开关

基本信息

Path： /v1/shadows/:instanceId/:productKey/states

Method： POST

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey

Body

名称	类型	是否必须	默认值	备注	其他信息
shadowState	boolean	非必须		默认false，产品是否开启影子设备功能

返回数据

无

设备影子获取

基本信息

Path： /v1/shadows/:instanceId/:productKey/:deviceName

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
instanceId
productKey
deviceName

Query

参数名称	是否必须	示例	备注
pageNo	是
pageSize	是
propertyName	否		模糊查询，同时匹配name和displayName
bindName	否		槽位ID，默认为MAIN，即主设备

返回数据

名称	类型	是否必须	默认值	备注	其他信息
totalCount	number	必须
result	object []	必须
├─ name	string	必须		名称
├─ displayName	string	必须		备注名称
├─ value	object	必须		属性值，数据格式见备注
├─ @type	string	必须		数据类型
├─ value	object	必须		数据值，数据格式见备注
├─ field_2	object	必须
├─ @type	string	必须
├─ value	string	必须
├─ unit	string	必须		单位
├─ unitType	string	必须		单位类型
├─ timeStamp	number	必须		时间戳
deviceShadow	string	必须		设备影子
pageNo	number	必须
pageSize	number	必须
propertyName	string	必须
bindName	string	必须