DeleteDevice - IoT Platform

使用說明

調用本介面前須知

使用RAM使用者帳號時，為保障裝置安全，您可建立自訂權限原則進行精微調權限管理。具體內容，請參見IoT授權映射表和自訂許可權。

警告

裝置刪除後，裝置ID（IotId）將失效，與裝置關聯的其他資訊也一併刪除，您將無法執行與該裝置關聯的任何操作。
在物聯網平台控制台刪除裝置前，對應的真實裝置必須離線。否則，在物聯網平台刪除該裝置後，真實裝置會一直向物聯網平台發起建連請求，發起請求數超出限制後，觸發物聯網平台的限流機制，會影響您當前帳號下裝置的正常接入。
裝置刪除後，該裝置認證會失效，且不能恢複。請謹慎操作。

調用本介面時

傳入請求參數時，需傳入IotId或ProductKey與DeviceName組合，用於指定裝置。
如果指定裝置是網關裝置，且其子裝置數量超過2000個，調用本介面會建立刪除裝置拓撲關係的裝置任務，以非同步方式刪除拓撲關係，並返回參數JobId （任務ID）。

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

說明單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

名稱	類型	是否必選	樣本值	描述
Action	String	是	DeleteDevice	系統規定參數。取值：DeleteDevice。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a1FlqIQ****	要刪除的裝置所屬的產品ProductKey。重要如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	light	指定要刪除的裝置的名稱。重要如果傳入該參數，需同時傳入ProductKey。
IotId	String	否	MpEKNuEUJzIORNANAWJX0010929900*****	要刪除的裝置ID。重要 IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果傳入該參數，則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

名稱	類型	樣本值	描述
Code	String	iot.prod.NullProductKey	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	入參產品ID沒有賦值。	調用失敗時，返回的出錯資訊。
RequestId	String	57b144cf-09fc-4916-a272-a62902d5b207	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	false	表示是否調用成功。 true：調用成功。 false：調用失敗。

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公用請求參數>

正常返回樣本

XML格式

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

JSON格式

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

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