方舟物联网使用手册

# BatchCustomRegisterDevice

调用该接口在指定产品下批量注册多个设备（自定义设备名称）。当注册设备数量过多时请使用post请求。

# 使用说明

单次调用，最多可创建10000个设备。

# 请求参数

名称 类型 是否必选 示例值 描述
Action String 是 BatchCustomRegisterDevice 系统规定参数。取值：BatchCustomRegisterDevice。
ProductKey String 是 a1BwAGV**** 要注册的设备所属的产品ProductKey。
IotInstanceId String 是 70255861902711**** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
DeviceNameList.N.DeviceName String 是 light1 要注册的设备名称。设备名称在产品内具有唯一性。支持英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、半角句号（.）、半角冒号（:），长度限制为4~32个字符。说明单次调用，N从1开始按照顺序最多能传入10000个设备名称，超过该限制的数据会被丢弃。
DeviceNameList.N.DeviceNickname String 否 智能灯1 要注册的设备的备注名称。支持中文汉字、英文字母、数字和下划线（_），备注名称长度为2~64个字符。重要若传入该参数，则必须同时传入DeviceNameList.N.DeviceName。
DeviceNameList.N.DeviceSecret String 否 UcRIilBNjn3CR0zPlw5tvQ0HrNkN**** 要注册的设备的密钥。密钥为32位字符串，支持英文字母和数字。重要若传入该参数，则必须同时传入DeviceNameList.N.DeviceName，若不传入该参数，则系统会自动生成密钥。

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时，返回的错误码。
Data Struct 调用成功时，返回的数据。
ApplyId String 715*************** 调用成功时，系统返回的申请批次ID。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
RequestId String ssLVSvX6Kj5vWlq3eiWD4MjscIqOvTxT 平台为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。true：调用成功。false：调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=BatchCheckDeviceNames
&productKey=a1BwAGV****
&IotInstanceId=70255861902711****
&DeviceNameList.1.DeviceName=light1
&DeviceNameList.2.DeviceName=light2
&DeviceNameList.3.DeviceName=light3
&DeviceNameList.3.DeviceNickname=智能灯3
&DeviceNameList.3.DeviceSecret=UcRIilBNjn3CR0zPlw5tvQ0HrNkN****
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
  <Data>
    <ApplyId>"715***************"</ApplyId>
  </Data>
  <RequestId>ssLVSvX6Kj5vWlq3eiWD4MjscIqOvTxT</RequestId>
  <Success>true</Success>
</xml>

JSON格式

{
  "Data": {
    "ApplyId": "715***************"
  },
  "RequestId": "ssLVSvX6Kj5vWlq3eiWD4MjscIqOvTxT",
  "Success": true
}

← 通过批次号查询批量注册的设备信息 →