调用该接口删除指定设备,支持同时删除网关设备的拓扑关系。
使用说明
调用本接口前须知使用RAM用户账号时,为保障设备安全,您可创建自定义权限策略进行精细化权限管理。具体内容,请参见IoT授权映射表和自定义权限。
警告
设备删除后,设备ID(IotId)将失效,与设备关联的其他信息也一并删除,您将无法执行与该设备关联的任何操作。 在物联网平台控制台删除设备前,对应的真实设备必须离线。否则,在物联网平台删除该设备后,真实设备会一直向物联网平台发起建连请求,发起请求数超出限制后,触发物联网平台的限流机制,会影响您当前账号下设备的正常接入。 设备删除后,该设备证书会失效,且不能恢复。请谨慎操作。 调用本接口时 传入请求参数时,需传入IotId或ProductKey与DeviceName组合,用于指定设备。 如果指定设备是网关设备,且其子设备数量超过2000个,调用本接口会创建删除设备拓扑关系的设备任务,以异步方式删除拓扑关系,并返回参数JobId (任务ID)。您可通过调用接口QueryJob,查看任务执行结果。QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
说明
单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
请求参数
名称类型是否必选示例值描述 名称 类型 是否必选 示例值 描述 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的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
示例
请求示例
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 }