調用該接口重置指定設備，包括重置直連設備一型一密動態注冊狀態，或刪除網關設備的拓撲關系。

使用說明

  • 如果直連設備通過動態注冊獲取設備證書信息（ProductKey、DeviceName和DeviceSecret）并激活后，您可調用本接口，重置設備的動態注冊狀態為未注冊，然后再次通過動態注冊獲取設備證書信息。
    說明 調用本接口是重置設備動態注冊狀態，不是重置設備激活狀態，即物聯網平臺控制臺對應設備的狀態不會重置為未激活。
  • 如果指定設備是網關設備，且其子設備數量超過2000個，調用本接口會創建刪除設備拓撲關系的設備任務，以異步方式刪除拓撲關系，并返回參數JobId （任務ID）。您可通過調用接口QueryJob，查看任務執行結果。

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
}