阿里云物联网平台BatchRegisterDevice

调用该接口在指定产品下批量注册多个设备(随机生成设备名)。

限制说明

单次调用,最多可创建1,000 个设备。

说明

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

  • 由系统随机生成设备名称:调用本接口。

    建议按照以下流程注册设备和查看结果。

    1. 调用本接口批量注册设备。

      返回成功结果,表示批量注册的申请已经提交成功。实际的注册是异步执行,会有一个过程。

    2. 调用QueryBatchRegisterDeviceStatus查看设备注册结果。
    3. 调用QueryPageByApplyId查看批量注册的设备信息(DeviceName、DeviceSecret、IotId)。
  • 自定义设备名称:请参见BatchRegisterDeviceWithApplyId。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:BatchRegisterDevice
ProductKey String 要批量注册的设备所隶属的产品Key。
Count Integer 要注册的设备数量,取值不能大于1,000。
IotInstanceId String 公共实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 请参见公共参数。

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码。
Data Data 调用成功时,返回的数据。详情见下表Data。
表 1. Data
名称 类型 描述
ApplyId Long 调用成功时,系统返回的申请批次ID。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDevice
&ProductKey=al*********
&Count=10
&公共请求参数

返回示例

  • JSON格式

    {
      "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",  
      "Success": true,
      "Data": {
        "ApplyId": 4415
      }
    }
  • XML格式

    <?xml version='1.0' encoding='utf-8'?>
    <BatchRegisterDeviceResponse>
        <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
        <Success>true</Success>
        <Data>
            <ApplyId>4415</ApplyId>
        </Data>
    </BatchRegisterDeviceResponse>

原创文章,作者:网友投稿,如若转载,请注明出处:https://www.cloudads.cn/archives/33536.html

发表评论

登录后才能评论