調(diào)用該接口刪除指定設(shè)備，支持同時刪除網(wǎng)關(guān)設(shè)備的拓撲關(guān)系。

使用說明

調(diào)用本接口前須知

使用RAM用戶賬號時，為保障設(shè)備安全，您可創(chuàng)建自定義權(quán)限策略進行精細化權(quán)限管理。具體內(nèi)容，請參見IoT授權(quán)映射表和自定義權(quán)限。

警告
  • 設(shè)備刪除后，設(shè)備ID（IotId）將失效，與設(shè)備關(guān)聯(lián)的其他信息也一并刪除，您將無法執(zhí)行與該設(shè)備關(guān)聯(lián)的任何操作。
  • 在物聯(lián)網(wǎng)平臺控制臺刪除設(shè)備前，對應的真實設(shè)備必須離線。否則，在物聯(lián)網(wǎng)平臺刪除該設(shè)備后，真實設(shè)備會一直向物聯(lián)網(wǎng)平臺發(fā)起建連請求，發(fā)起請求數(shù)超出限制后，觸發(fā)物聯(lián)網(wǎng)平臺的限流機制，會影響您當前賬號下設(shè)備的正常接入。
  • 設(shè)備刪除后，該設(shè)備證書會失效，且不能恢復。請謹慎操作。
調(diào)用本接口時
  • 傳入請求參數(shù)時，需傳入IotId或ProductKey與DeviceName組合，用于指定設(shè)備。
  • 如果指定設(shè)備是網(wǎng)關(guān)設(shè)備，且其子設(shè)備數(shù)量超過2000個，調(diào)用本接口會創(chuàng)建刪除設(shè)備拓撲關(guān)系的設(shè)備任務(wù)，以異步方式刪除拓撲關(guān)系，并返回參數(shù)JobId （任務(wù)ID）。您可通過調(diào)用接口QueryJob，查看任務(wù)執(zhí)行結(jié)果。

QPS限制

單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為50。

說明 單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的配額。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DeleteDevice

系統(tǒng)規(guī)定參數(shù)。取值：DeleteDevice。
IotInstanceId String 否 iot-cn-0pp1n8t****

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調(diào)用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。

實例的更多信息，請參見實例概述。
ProductKey String 否 a1FlqIQ****

要刪除的設(shè)備所屬的產(chǎn)品ProductKey。

重要 如果傳入該參數(shù)，需同時傳入DeviceName。
DeviceName String 否 light

指定要刪除的設(shè)備的名稱。

重要 如果傳入該參數(shù)，需同時傳入ProductKey。
IotId String 否 MpEKNuEUJzIORNANAWJX0010929900*****

要刪除的設(shè)備ID。

重要 IotId作為設(shè)備唯一標識符，和ProductKey與DeviceName組合是一一對應的關(guān)系。如果傳入該參數(shù)，則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.prod.NullProductKey

調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。
ErrorMessage String 入?yún)a(chǎn)品ID沒有賦值。

調(diào)用失敗時，返回的出錯信息。
RequestId String 57b144cf-09fc-4916-a272-a62902d5b207

阿里云為該請求生成的唯一標識符。
Success Boolean false

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請求示例

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

正常返回示例

XML格式

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

JSON格式

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