DeleteDevice_物联网平台_API文档

插件下载了解更多
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.

接口说明

使用说明

调用本接口前须知

  • 使用主账号登录时,物联网平台会进行短信验证,以确认是您本人操作。
  • 使用 RAM 用户账号时,物联网平台默认无需短信验证。为保障设备安全,您可创建自定义权限策略进行精细化权限管理。具体内容,请参见 IoT 授权映射表自定义权限
警告 - 设备删除后,设备 ID(**IotId**)将失效,与设备关联的其他信息也一并删除,您将无法执行与该设备关联的任何操作。 - 在物联网平台控制台删除设备前,对应的真实设备必须离线。否则,在物联网平台删除该设备后,真实设备会一直向物联网平台发起建连请求,发起请求数超出限制后,触发物联网平台的限流机制,会影响您当前账号下设备的正常接入。 - 设备删除后,该设备证书会失效,且不能恢复。请谨慎操作。

调用本接口时

  • 传入请求参数时,需传入 IotIdProductKeyDeviceName 组合,用于指定设备。
  • 如果指定设备是网关设备,且其子设备数量超过 2000 个,调用本接口会创建删除设备拓扑关系的设备任务,以异步方式删除拓扑关系,并返回参数 JobId (任务 ID)。您可通过调用接口 QueryJob ,查看任务执行结果。

QPS 限制

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

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

流控信息

请求速率为50/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:DeleteDevice
Delete
全部资源
*

请求参数

字段名称字段详情
IotInstanceIdstring

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

示例值:iot-cn-0pp1n8t****
ProductKeystring

要删除的设备所属的产品 ProductKey展开详情

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

指定要删除的设备的名称。展开详情

示例值:light
IotIdstring

要删除的设备 ID。展开详情

示例值:MpEKNuEUJzIORNANAWJX0010929900*****

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.prod.NullProductKey
ErrorMessagestring

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

示例值:入参产品ID没有赋值。
RequestIdstring

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

示例值:57b144cf-09fc-4916-a272-a62902d5b207
Successboolean

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

示例值:false

返回示例

变更历史

暂无变更历史

相关示例

Iot删除设备
2021-01-15