调用该接口重置指定设备，包括重置直连设备一型一密动态注册状态，或删除网关设备的拓扑关系。

使用说明

  • 如果直连设备通过动态注册获取设备证书信息（ProductKey、DeviceName和DeviceSecret）并激活后，您可调用本接口，重置设备的动态注册状态为未注册，然后再次通过动态注册获取设备证书信息。
    说明 调用本接口是重置设备动态注册状态，不是重置设备激活状态，即物联网平台控制台对应设备的状态不会重置为未激活。
  • 如果指定设备是网关设备，且其子设备数量超过2000个，调用本接口会创建删除设备拓扑关系的设备任务，以异步方式删除拓扑关系，并返回参数JobId （任务ID）。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为500。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ResetThing

系统规定参数。取值：ResetThing。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

注意
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

ProductKey String 否 a1KiV******

要重置的设备所属的产品ProductKey。

说明 如果传入该参数，需同时传入DeviceName。
DeviceName String 否 device1

指定重置的设备的名称。

说明 如果传入该参数，需同时传入ProductKey。
IotId String 否 SR8FiTu1R9tlUR2V1bmi0010a5****

要重置的设备ID。

说明 如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，与ProductKey和DeviceName组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
JobId String 450407b***

设备任务ID，设备任务的全局唯一标识符。
RequestId String 57b144cf-09fc-4916-a272-a62902d5b207

阿里云为该请求生成的唯一标识符。
Success Boolean true

是否调用成功。true表示调用成功，false表示调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=ResetThing
&IotId=MpEKNuEUJzIORNANAWJX0010929900*****
&<公共请求参数>

正常返回示例

XML格式 

<ResetThingResponse>
      <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
      <Success>true</Success>
</ResetThingResponse>

JSON格式 

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success": true
}