调用该接口批量把设备迁移到当前region。
路径 | /living/cloud/device/region/distribute |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
productKey | String | 是 | a1a******U35 | 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
deviceNames | List | 是 | 产品的DeviceName列表,设备证书信息之一。 | |
bindingCheck | Boolean | 是 | true | 是否校验设备绑定状态。true:校验设备是否绑定,若果设备已绑定,则不迁移该设备;false:不校验设备是否绑定。 |
pushDeviceRegionSwitch | Boolean | 是 | true | 是否给设备推送切换region的指令。true:给设备推送切换region的指令;false:只迁移设备数据,不给设备推送切换region的指令。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码,200:成功。 |
|
message | String |
错误消息。 |
|
localizedMsg | String |
本地语言错误消息。 |
|
data | JSON |
设备迁移结果。 |
|
productKey | String |
产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
deviceName | String |
产品的DeviceName,设备证书信息之一。 |
|
succeed | Boolean |
设备同步是否成功。 |
|
resultCode | String |
设备同步的错误码。0:迁移成功;28612:设备已经绑定到用户;6638:设备正在迁移中;28505:产品不存在。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"productKey": "a1a******U35",
"deviceNames": "value1",
"bindingCheck":true,
"pushDeviceRegionSwitch":true
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": [
{
"productKey":"a1******35",
"deviceName":"68******38",
"resultCode":"0",
"succeed":true
}
]
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}