RemoveThingTopo
调用该接口移除网关与子设备的拓扑关系
服务地址:
华东2(上海)
输入参数
只看必填
IotInstanceId实例ID
ProductKey要删除拓扑关系的设备所属的产品Prod...
DeviceName要删除拓扑关系的设备名称
IotId要删除拓扑关系的设备ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

  • 如果传入的设备信息是网关设备,则移除该网关与其下所有子设备的拓扑关系。
  • 如果传入的设备信息是子设备,则移除该子设备与其关联网关的拓扑关系。
  • 如果网关设备的子设备数量超过 2000 个,调用本接口会创建删除设备拓扑关系的设备任务,以异步方式删除拓扑关系,并返回参数 JobId (任务 ID)。您可通过调用接口 QueryJob ,查看任务执行结果。

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 500。

说明 RAM 用户共享阿里云账号配额。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot_instc_pu****_c*-v64********
ProductKeystring

要删除拓扑关系的设备所属的产品 ProductKey展开详情

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
DeviceNamestring

要删除拓扑关系的设备名称。展开详情

示例值:light
IotIdstring

要删除拓扑关系的设备 ID。物联网平台为该设备颁发的 ID,设备的唯一标识符。展开详情

示例值:Q7uOhVRdZRRlDnTLv****00100

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
Databoolean

删除拓扑关系的结果。展开详情

示例值:true
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

表示是否调用成功。展开详情

示例值:true
变更历史
暂无变更历史