调用该接口以管理员身份批量查询设备和目标用户的被分享关系。
路径 | /living/user/device/shared/batch/get |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 5000 |
请求参数
名称 | 位置 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
targetIdentityId | String | 是 | 5008al73b368bbb9f74d29ed5b****1a0b5d1858 | 目标用户的 IdentityID,用户的唯一标识。 | |
deviceList | List | 是 | [{"iotId":"edwB6TqvOW****mY7TNa000100"}] | 设备列表,size 的最大限制为 50 个。包含以下参数:iotid(设备ID)、productKey(产品的Key)、deviceName(设备名称)。 | |
iotId | String | 否 | edwB6TqvOW****mY7TNa000100 | 设备ID,生活物联网平台为设备颁发的ID。 如果 productKey 和 deviceName 字段为空,该字段必填。 如果 iotId,productKey 和 deviceName 都不为空,以 iotId 为设备的唯一标识。 | |
productKey | String | 否 | a1bk****leX | 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 如果 iotId 字段为空,该字段必填。 | |
deviceName | String | 否 | myDevice | 设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应结果。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
productKey | String |
设备所属产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
deviceName | String |
设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 |
|
shared | Boolean |
设备是否分享给了目标用户。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"targetIdentityId": "5008al73b368bbb9f74d29ed5b****1a0b5d1858",
"deviceList":[
{
"iotId": "edwB6TqvOW****mY7TNa000100"
}
]
}
}
正常返回示例
JSON
格式
{
"code":200,
"message":"success",
"localizedMsg":"",
"data":[
{
"iotId":"edwB6TqvOW2iXnmY7TNa00****",
"shared":true
}
]
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}