调用该接口在指定产品下批量自定义设备名称。物联网平台将检查名称的合法性。

限制说明

单次调用,最多能定义1,000 个设备名称。

接口使用说明

该接口和BatchRegisterDeviceWithApplyId接口结合使用,在一个产品下批量注册多个设备,并且为每个设备单独命名。

批量注册设备流程:

  1. 调用本接口,传入要批量注册的设备的名称,物联网平台返回申请批次ID(ApplyId)。返回成功结果,表示批量校验设备名称的申请已经提交成功。实际的校验是异步执行的,会有一个过程。
  2. 调用QueryBatchRegisterDeviceStatus查看名称设置结果。
  3. 调用BatchRegisterDeviceWithApplyId批量注册设备。
  4. (可选)调用QueryBatchRegisterDeviceStatus查看设备注册结果。
  5. 调用QueryPageByApplyId查看批量注册的设备信息。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:BatchCheckDeviceNames
ProductKey String 要批量注册的设备所隶属的产品Key。
DeviceName List<String>

要批量注册的设备的名称列表。每个设备名称应包含4-32个字符,可以包含英文字母、数字和特殊字符(连字符、下划线、@符号、点号、和英文冒号)。

说明 单次调用,最多能传入1,000个设备名称。
IotInstanceId String 公共实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckDeviceNames
&productKey=al**********
&DeviceName.1=device1
&DeviceName.3=device2
&DeviceName.2=device3
&DeviceName.4=device4
&公共请求参数

返回示例

  • JSON格式

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

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