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

接口说明

使用说明

批量注册设备有两种方式:

  • 由系统随机生成设备名称:请调用 BatchRegisterDevice 接口。
  • 自定义设备名称:需本接口与 BatchCheckDeviceNames 等接口结合实现。请按以下流程操作:
    1. 调用 BatchCheckDeviceNames 接口,传入要批量注册的设备的名称。物联网平台检查您提交的设备名称符合要求后,返回申请批次 ID(ApplyId)。ApplyId 将用于设备名称校验结果查询、批量设备注册和设备信息查询。

    2. 调用 QueryBatchRegisterDeviceStatus 接口,根据申请批次 ID,查看名称校验结果。请确保自定义设备名称全部校验通过,再执行后续操作完成设备注册。

      说明 如果有校验失败的设备名称,请根据错误信息提示进行修正,然后重新调用 BatchCheckDeviceNames 接口获取新的申请批次 ID(ApplyId)后,再次调用 QueryBatchRegisterDeviceStatus 接口确认全部设备名称校验通过。
    3. 调用本接口批量注册设备。本接口调用返回的成功结果,仅表示批量注册的申请已经提交成功。实际的注册会有一个过程。

    4. (可选)调用 QueryBatchRegisterDeviceStatus 查看设备注册结果。

    5. 调用 QueryPageByApplyId 查看批量注册的设备信息。

QPS 限制

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

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

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

要批量注册的设备所属的产品 ProductKey

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
ApplyIdinteger<int64>

要批量注册的设备的申请批次 ID。申请批次 ID 由调用 BatchCheckDeviceNames 接口生成。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1295006

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

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

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

示例值:true
Dataobject

调用成功时,返回的数据,详情请参见以下参数。

返回示例

变更历史

暂无变更历史