調用該接口移除指定網關與子設備的拓撲關系,或指定子設備與其關聯網關的拓撲關系。

使用說明

  • 如果傳入的設備信息是網關設備,則移除該網關與其下所有子設備的拓撲關系。
  • 如果傳入的設備信息是子設備,則移除該子設備與其關聯網關的拓撲關系。

  • 如果網關設備的子設備數量超過2000個,調用本接口會創建刪除設備拓撲關系的設備任務,以異步方式刪除拓撲關系,并返回參數JobId (任務ID)。您可通過調用接口QueryJob,查看任務執行結果。

QPS限制

單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為500。

說明 RAM用戶共享阿里云賬號配額。

調試

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

請求參數

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

系統規定參數。取值:RemoveThingTopo。

IotInstanceId String iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID

注意
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無ID值,則無需傳入。

實例的更多信息,請參見實例概述

ProductKey String a1BwAGV****

要刪除拓撲關系的設備所屬的產品ProductKey

說明 如果傳入該參數,需同時傳入DeviceName
DeviceName String light

要刪除拓撲關系的設備名稱。

說明 如果傳入該參數,需同時傳入ProductKey
IotId String Q7uOhVRdZRRlDnTLv****00100

要刪除拓撲關系的設備ID。物聯網平臺為該設備頒發的ID,設備的唯一標識符。

說明 如果傳入該參數,則無需傳入ProductKeyDeviceNameIotId作為設備唯一標識符,和ProductKeyDeviceName組合是一一對應的關系。如果您同時傳入IotIdProductKeyDeviceName組合,則以IotId為準。

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

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼

Data Boolean true

刪除拓撲關系的結果。

  • true:刪除成功。
  • false:刪除失敗。
ErrorMessage String 系統異常

調用失敗時,返回的出錯信息。

JobId String 450407b***

設備任務ID,設備任務的全局唯一標識符。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

Success Boolean true

表示是否調用成功。

  • true:調用成功。
  • false:調用失敗。

示例

請求示例

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

正常返回示例

XML格式

<RemoveThingTopoResponse>
  <Data>true</Data>
  <RequestId>098BEEF4-58F4-4181-A891-5D37DB6C4C3B</RequestId>
  <Success>true</Success>
</RemoveThingTopoResponse>

JSON格式

{
    "Data": true,
    "RequestId": "098BEEF4-58F4-4181-A891-5D37DB6C4C3B",
    "Success": true
}