调用该接口批量校验导入的设备。

QPS限制

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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String BatchCheckImportDevice

系统规定参数。取值:BatchCheckImportDevice。

ProductKey String a1BwAGV****

设备所属云网关产品的ProductKey

DeviceList.N.DeviceName String light

设备的名称。

设备名称支持英文字母、数字、短划线(-)、下划线(_)、at(@)、英文句号(.)和英文冒号(:),长度限制为4~32个字符。

设备名称在产品维度下不可重复。

说明 单次调用该接口,最多能传入10,000个设备名称。超过该限制的数据会被丢弃。
DeviceList.N.DeviceSecret String b4d43f7******10ba5e5

设备的密钥。

设备密钥支持英文字母、数字、短划线(-)、下划线(_)、at(@)、英文句号(.)和英文冒号(:),长度限制为1~32个字符。

说明 单次调用该接口,最多能传入10,000个设备密钥。超过该限制的数据会被丢弃。
DeviceList.N.Sn String QC4******001

设备的序列号。

序列号支持英文字母、数字和下划线(_),长度限制为1~64个字符。

说明 单次调用该接口,最多能传入10,000个设备序列号。超过该限制的数据会被丢弃。
IotInstanceId String iot-1n8t****

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

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无实例概览页面或ID值,则无需传入。

实例的更多信息,请参见实例概述

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

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

Data Struct

调用成功时,如果有校验失败的数据,则返回对应的失败信息。

InvalidDeviceNameList List { "InvalidDeviceNameList": [ "APT$", "aw" ] }

设备信息校验失败时,返回的不合法设备名称的列表。

InvalidDeviceSecretList List { "InvalidDeviceSecretList": [ "^67$", "1" ] }

设备信息校验失败时,返回的不合法设备密钥的列表。

InvalidSnList List { "InvalidSnList": [ "" ] }

设备信息校验失败时,返回的不合法设备序列号的列表。

RepeatedDeviceNameList List { "RepeatedDeviceNameList": [ "abcd", "asdf" ] }

设备信息校验失败时,返回的重复设备名称的列表。

ErrorMessage String 系统异常

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

RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

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

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckImportDevice
&DeviceList.1.DeviceName=device1
&DeviceList.2.DeviceName=device2
&DeviceList.1.DeviceSecret=b4d43f7******10ba5e5
&DeviceList.2.DeviceSecret=912179******700210b4
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<公共请求参数>

正常返回示例

XML格式

<BatchCheckImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</BatchCheckImportDeviceResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 iot.device.TooManyDeviceNamesPerRequest The devices you query exceed the maximum number. 请求查询的设备名称数量超过最大限制。
400 iot.device.NoneDeviceNameElement The DeviceName list is empty. 设备名称列表为空。
400 iot.device.InvalidDeviceParams The request parameters are invalid. 请求参数非法

访问错误中心查看更多错误码。