调用该接口根据申请批次ID(ApplyId)批量注册设备。

使用说明

该接口需要和BatchCheckDeviceNames接口结合使用,实现在一个产品下批量注册(即新建)多个设备,并且为每个设备单独命名。

建议按照以下流程批量注册设备:

  1. 调用BatchCheckDeviceNames接口,传入要批量注册的设备的名称。物联网平台检查您提交的设备名称符合要求后,返回申请批次ID(ApplyId)。
  2. 调用QueryBatchRegisterDeviceStatus查看设备名称设置结果。
  3. 调用本接口批量注册设备。本接口调用返回的成功结果,仅表示批量注册的申请已经提交成功。实际的注册会有一个过程。
  4. 调用QueryBatchRegisterDeviceStatus查看设备注册结果(这一步不是必须步骤)。
  5. 调用QueryPageByApplyId查看批量注册的设备信息。
说明 如果您想在一个产品下批量注册多个设备,且不指定设备名称,设备名称由系统随机生成,您可以调用BatchRegisterDevice接口。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:BatchRegisterDeviceWithApplyId
ProductKey String 要批量注册的设备所隶属的产品Key。
ApplyId Long 要批量注册的设备的申请批次ID。申请批次ID由调用BatchCheckDeviceNames接口返回。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
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=BatchRegisterDeviceWithApplyId
&ProductKey=al*********
&ApplyId=4416
&公共请求参数

返回示例

  • JSON格式

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

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