调用该接口恢复设备的出厂设置,删除设备历史数据,并通知设备端,同时会清除云端设备快照数据。该接口调用会返回一个恢复出厂设置任务的ID,任务后台异步执行,通过该任务ID可查询任务的执行状态(配合“查询恢复出厂设置任务的执行状态”接口使用)。

路径 /living/device/reset
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
iotId String 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
offlineReset Boolean 是否支持离线reset。取值为true(表示支持在离线状态下reset设备);false(表示不支持在离线状态下reset设备)。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误信息。

data String

设备恢复出厂设置的任务ID。因为任务后台异步执行,您可以使用该ID通过调用/living/device/reset/task/state/get接口查询任务的执行状态。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"iotId": "value0",
		"offlineReset": "value1"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": "1186249123003700224"
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}