ResetThing - IoT Platform

使用說明

如果直連裝置通過動態註冊擷取裝置認證資訊（ProductKey、DeviceName和DeviceSecret）並啟用後，您可調用本介面，重設裝置的動態註冊狀態為未註冊，然後再次通過動態註冊擷取裝置認證資訊。
說明調用本介面是重設裝置動態註冊狀態，不是重設裝置啟用狀態，即物聯網平台控制台對應裝置的狀態不會重設為未啟用。
如果指定裝置是網關裝置，且其子裝置數量超過2000個，調用本介面會建立刪除裝置拓撲關係的裝置任務，以非同步方式刪除拓撲關係，並返回參數JobId （任務ID）。

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為500。

說明 RAM使用者共用阿里雲帳號配額。

名稱	類型	是否必選	樣本值	描述
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
}

訪問錯誤中心查看更多錯誤碼。