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

接口说明

注册设备指在物联网平台产品下添加设备。在指定产品下成功注册设备后,阿里云物联网平台为设备颁发全局唯一的设备 ID(IotId),用来标识该设备。在进行与设备相关的操作时,您可能需要提供目标设备的 IotId。

您也可以使用 ProductKey 和 DeviceName 组合来标识一个设备。其中 ProductKey 是新建产品时,物联网平台为产品颁发的 ProductKey,DeviceName 是注册设备时,由您指定或由系统随机生成的设备名称。IotId 的优先级高于 ProductKey 和 DeviceName 组合。

如需在同一产品下,批量注册多个设备,请参见 BatchRegisterDeviceWithApplyId 接口的使用说明

QPS 限制

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

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

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

待注册设备所隶属的产品的 ProductKey。ProductKey 是物联网平台为新建产品颁发的产品 Key,作为其全局唯一标识符。展开详情

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

为待注册的设备命名。设备名称长度为 4~32 个字符,可以包含英文字母、数字和特殊字符:短划线(-)、下划线(_)、at(@)、半角句号(.)、半角冒号(:)。展开详情

示例值:light
DevEuistring

LoRaWAN 设备的 DevEUI。展开详情

示例值:e8SDdgeIlk3nED****
Nicknamestring

为待注册的设备设置备注名称。备注名称长度为 4~64 个字符,可包含中文汉字、英文字母、数字和下划线(_)。一个中文汉字算 2 个字符。展开详情

示例值:园区灯
PinCodestring

LoRaWAN 设备的 PIN Code,用于校验 DevEUI 的合法性。展开详情

示例值:DIe80dfeg*****
JoinEuistring

LoRaWAN 设备的入网凭证 JoinEui。展开详情

示例值:Ede4tde8erth****
AppKeystring

LoRaWAN 设备的 AppKey。展开详情

示例值:674f***参考取值来源:
    QueryStudioAppList
LoraNodeTypestring

LoRaWAN 设备类型。可取值:展开详情

示例值:ALIYUNDEFINED

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

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

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

示例值:true
Dataobject

调用成功时,返回注册的设备信息。

返回示例

变更历史

暂无变更历史

相关示例

Iot注册设备
2021-01-21