调用BatchCheckVehicleDevice批量校验导入的云网关设备

使用说明

本接口适用于批量校验导入的JT/T 808协议、GB/T 32960协议和SL 651协议的云网关设备。

您可在导入云网关设备后，调用本接口校验导入的设备认证信息。

校验JT/T 808协议设备时，需传入请求参数DeviceList.N.Manufacturer、DeviceList.N.DeviceModel和DeviceList.N.DeviceId。
校验GB/T 32960协议设备时，需传入请求参数DeviceList.N.DeviceName。
校验SL 651协议设备时，需传入请求参数DeviceList.N.DeviceName和DeviceList.N.DeviceId。

使用云网关协议接入设备的具体流程和通信说明，请参见JT/T 808协议云网关概述、GB/T 32960协议云网关概述和SL 651协议云网关概述。

QPS限制

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

说明

单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

调试

请求参数

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

名称	类型	是否必选	示例值	描述
Action	String	是	BatchCheckVehicleDevice	系统规定参数。取值：BatchCheckVehicleDevice。
IotInstanceId	String	是	iot-1n8t****	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。实例的更多信息，请参见实例概述。
ProductKey	String	是	a1Bw****	设备所属云网关产品的ProductKey。
DeviceList.N.Manufacturer	String	否	mf0001	校验导入的JT/T 808协议云网关设备时，需传入的设备厂商ID。设备厂商ID支持英文字母、数字、短划线（-），长度限制为4~11个字符。说明单次调用该接口，最多能传入10,000个设备厂商ID。超过该限制的数据会被丢弃。
DeviceList.N.DeviceModel	String	否	dm0001	校验导入的JT/T 808协议云网关设备时，需传入的设备型号。设备型号支持英文字母、数字、短划线（-），长度限制为4~30个字符。说明单次调用该接口，最多能传入10,000个设备型号。超过该限制的数据会被丢弃。
DeviceList.N.DeviceId	String	否	di0001	校验导入的JT/T 808协议云网关设备时，需传入的设备ID。设备ID支持英文字母、数字、短划线（-），长度限制为4~30个字符。说明单次调用该接口，最多能传入10,000个设备ID。超过该限制的数据会被丢弃。
DeviceList.N.DeviceName	String	否	vin0001	校验导入的GB/T 32960协议或SL 651协议云网关设备时，需传入该参数。 GB/T 32960协议设备：传入车辆的识别代码作为设备名称。设备名称支持英文字母和数字，长度限制为4~17个字符。 SL 651协议设备：传入遥测站地址作为设备名称。设备名称仅支持数字，长度为10个字符。说明单次调用该接口，最多能传入10,000个设备名称。超过该限制的数据会被丢弃。
DeviceList.N.DeviceSecret	String	否	d32g	校验导入的SL 651协议云网关设备时，需传入遥测站密码作为设备密钥。设备密钥支持数字和a、b、c、d、e、f的大小写英文字母，长度为4个字符。说明单次调用该接口，最多能传入10,000个设备密钥。超过该限制的数据会被丢弃。

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

返回数据

名称	类型	示例值	描述

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见下文错误码。
Data	Struct		调用成功时，如果有校验失败的数据，则返回对应的失败信息。
InvalidDetailList	Array of InvalidDetailList		不合法设备列表信息。
DeviceId	String	di_*0001	JT/T 808协议云网关设备的设备ID。
DeviceModel	String	dm_*0001	JT/T 808协议云网关设备的设备型号。
DeviceName	String	device_*0001	GB/T 32960协议或SL 651协议云网关设备的设备名称。
ErrorMsg	String	The device name is illegal.	设备校验失败，返回的出错信息。
Manufacturer	String	mf_*0001	JT/T 808协议云网关设备的设备厂商ID。
InvalidDeviceIdList	List	{ "InvalidDeviceIdList": [ "DEVIC^*$" ] }	JT/T 808协议云网关设备信息校验失败时，返回的不合法设备ID的列表。
InvalidDeviceModelList	List	{ "InvalidDeviceModelList": [ "DEM$", "DE" ] }	JT/T 808协议云网关设备信息校验失败时，返回的不合法设备型号的列表。
InvalidDeviceNameList	List	{ "InvalidDeviceNameList": [ "APT$", "aw" ] }	GB/T 32960协议或SL 651协议云网关设备信息校验失败时，返回的不合法设备名称的列表。
InvalidManufacturerList	List	{ "InvalidManufacturerList": [ "manufacturer#&_", "aw" ] }	JT/T 808协议云网关设备信息校验失败时，返回的不合法设备厂商ID的列表。
RepeatedDeviceIdList	List	{ "RepeatedDeviceIdList": [ "deviceId01", "deviceId02" ] }	JT/T 808协议云网关设备信息校验失败时，返回的重复设备ID的列表。
RepeatedDeviceNameList	List	{ "RepeatedDeviceNameList": [ "abcd", "asdf" ] }	GB/T 32960协议或SL 651协议云网关设备信息校验失败时，返回的重复设备名称的列表。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里云为该请求生成的唯一标识符。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckVehicleDevice
&DeviceList.1.DeviceModel=dm0001
&DeviceList.1.Manufacturer=mf0001
&DeviceList.1.DeviceId=di0001
&ProductKey=a1BwAGV****
&IotInstanceId=iot-cv3********
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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