Resets a specified device, resets the unique-certificate-per-product authentication status of the device that is directly connected to IoT Platform, and deletes the current topology of the device.
Usage instructions
You cannot use dynamic registration to retrieve the device certificate information after a device that is directly connected to IoT Platform is activated. In this case, you can call the ResetThing operation to reset the device. Then, use dynamic registration to retrieve the new certificate information. The device certificate information includes ProductKey, DeviceName, and DeviceSecret.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ResetThing |
The operation that you want to perform. Set the value to ResetThing. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased. |
ProductKey | String | No | al12345**** |
The key of the product to which the device belongs. Note If you specify this parameter, you must also specify the DeviceName parameter.
|
DeviceName | String | No | device1 |
The name of the device to be reset. Note If you specify this parameter, you must also specify the ProductKey parameter.
|
IotId | String | No | SR8FiTu1R9tlUR2V1bmi0010a5**** |
The ID of the device. Note If you specify this parameter, you do not need to specify the ProductKey or DeviceName parameter. The IotId parameter is a globally unique identifier (GUID), and corresponds to a combination
of the ProductKey and DeviceName parameters. If you specify the IotId parameter and the combination of the ProductKey and DeviceName parameters at the same time, the IotId parameter takes precedence.
|
In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call failed. For more information about error codes, see Error codes. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call failed. |
RequestId | String | 57b144cf-09fc-4916-a272-a62902d5b207 |
The globally unique ID that is generated by Alibaba Cloud for the request. |
Success | Boolean | true |
Indicates whether the call was successful. true indicates that the call was successful. false indicates that the call failed. |
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=ResetThing
&IotId=MpEKNuEUJzIORNANAWJX0010929900*****
&<Common request parameters>
Sample success responses
XML
format
<ResetThingResponse>
<RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
<Success>true</Success>
</ResetThingResponse>
JSON
format
{
"RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.