ResetThing_物联网平台_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.

接口说明

使用说明

  • 如果直连设备通过动态注册获取设备证书信息(ProductKey、DeviceName 和 DeviceSecret)并激活后,您可调用本接口,重置设备的动态注册状态为未注册,然后再次通过动态注册获取设备证书信息。

    说明 调用本接口是重置设备动态注册状态,不是重置设备激活状态,即物联网平台控制台对应设备的状态不会重置为未激活。
  • 如果指定设备是网关设备,且其子设备数量超过 2000 个,调用本接口会创建删除设备拓扑关系的设备任务,以异步方式删除拓扑关系,并返回参数 JobId (任务 ID)。您可通过调用接口 QueryJob ,查看任务执行结果。

QPS 限制

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

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

要重置的设备所属的产品 ProductKey。展开详情

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

指定重置的设备的名称。展开详情

示例值:device1
IotIdstring

要重置的设备 ID。展开详情

示例值:SR8FiTu1R9tlUR2V1bmi0010a5****

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

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

是否调用成功。true 表示调用成功,false 表示调用失败。

示例值:true
JobIdstring

设备任务 ID,设备任务的全局唯一标识符。

示例值:450407b***

返回示例

变更历史

暂无变更历史

相关示例

禁用/解禁/重置https://iot.console.aliyun.com/devices/
2022-07-27