调用该接口在云网关产品下批量导入设备。
使用说明
本接口适用于批量导入JT/T 808协议和GB/T 32960协议的云网关设备。
QPS限制
单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
| Action | String | 是 | BatchImportVehicleDevice | 系统规定参数。取值：BatchImportVehicleDevice。 |
| 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协议云网关设备时，需传入车辆的识别代码作为设备名称。 设备名称支持英文字母和数字，长度限制为4~17个字符。 说明 单次调用该接口，最多能传入10,000个设备名称。超过该限制的数据会被丢弃。 |
调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
| Code | String | iot.system.SystemException | 调用失败时，返回的错误码。更多信息，请参见下文错误码。 |
| Data | Struct | 调用成功时，返回的数据。 |
|
| ApplyId | Long | 1295006 | 导入设备成功时，系统返回的申请批次ID。 |
| InvalidDetailList | Array of InvalidDetailList | 导入设备失败时，不合法设备列表信息。 |
|
| InvalidDetailList | |||
| DeviceId | String | di_*0001 | JT/T 808协议云网关设备的设备ID。 |
| DeviceModel | String | dm_*0001 | JT/T 808协议云网关设备的设备型号。 |
| DeviceName | String | device_*0001 | GB/T 32960协议云网关设备的设备名称。 |
| ErrorMsg | String | The device name is illegal. | 导入设备失败时，返回的出错信息。 |
| Manufacturer | String | mf_*0001 | JT/T 808协议云网关设备的设备厂商ID。 |
| InvalidDeviceIdList | List | { "InvalidDeviceIdList": [ "di&^", "&*G%" ] } | 导入JT/T 808协议云网关设备失败时，返回的不合法设备ID的列表。 |
| InvalidDeviceModelList | List | { "InvalidDeviceModelList": [ "dm$", "dm_uh" ] } | 导入JT/T 808协议云网关设备失败时，返回的不合法设备型号的列表。 |
| InvalidDeviceNameList | List | { "InvalidDeviceNameList": [ "APT$", "aw" ] } | 导入GB/T 32960协议云网关设备失败时，返回的不合法设备名称的列表。 |
| InvalidManufacturerList | List | { "InvalidManufacturerList": [ "bm*$", "#$F" ] } | 导入JT/T 808协议云网关设备失败时，返回的不合法设备厂商ID的列表。 |
| RepeatedDeviceIdList | List | { "RepeatedDeviceIdList": [ "^67$", "1" ] } | 导入JT/T 808协议云网关设备失败时，返回的重复设备ID的列表。 |
| RepeatedDeviceNameList | List | { "RepeatedDeviceNameList": [ "abcd", "asdf" ] } | 导入GB/T 32960协议云网关设备失败时，返回的重复设备名称的列表。 |
| ErrorMessage | String | 系统异常 | 调用失败时，返回的错误信息。 |
| RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E | 阿里云为该请求生成的唯一标识符。 |
| Success | Boolean | true | 是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchImportVehicleDevice
&DeviceList.1.DeviceModel=dm0001
&DeviceList.1.Manufacturer=mf0001
&DeviceList.1.DeviceId=di0001
&ProductKey=a1Bw****
&IotInstanceId=iot-cv3********
&<公共请求参数>正常返回示例
XML格式
<BatchImportVehicleDeviceResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Data>
<ApplyId>1295006</ApplyId>
</Data>
<Code></Code>
<Success>true</Success>
</BatchImportVehicleDeviceResponse>JSON格式
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Data": {
"ApplyId": 1295006
},
"Code": "",
"Success": true
}错误码
|
HttpCode |
错误码 |
错误信息 |
描述 |
| 400 | iot.device.TooManyDeviceNamesPerRequest | The devices you query exceed the maximum number. | 请求查询的设备名称数量超过最大限制。 |
| 400 | iot.device.ApplyManyDevicesFailed | An error occurred while creating multiple devices. | 申请批量创建设备失败。 |
| 400 | iot.common.InvalidTenant | the device tenantId is invalid. | 设备的租户信息不匹配。 |
| 400 | iot.device.InvalidFormattedDeviceNameInNameArray | The DeviceName list contains an invalid DeviceName. | 设备名称列表中存在非法格式的设备名称。 |
| 400 | iot.prod.InvalidProductAuthType | The product authentication type is invalid. | 不合法的产品认证类型。 |
| 400 | iot.prod.InvalidFormattedProductkey | The ProductKey format is invalid. | 入参产品ProductKey格式错误。 |
访问错误中心查看更多错误码。