调用该接口在云网关产品下批量导入设备。
使用说明
本接口适用于批量导入JT/T 808协议、GB/T 32960协议和SL 651协议的云网关设备。
调用本接口前,需已创建对应协议的云网关产品。具体操作,请参见创建云网关产品(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协议云网关概述。
使用限制
单次调用该接口,最多能传入10,000个设备的认证信息。超过该限制的数据会被丢弃。
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协议或SL 651协议云网关设备时,需传入该参数。
单次调用该接口,最多能传入10,000个设备名称。超过该限制的数据会被丢弃。 |
DeviceList.N.DeviceSecret | String | 否 | d32g | 导入SL 651协议云网关设备时,需传入遥测站密码作为设备密钥。 设备密钥支持数字和a、b、c、d、e、f的大小写英文字母,长度为4个字符。 单次调用该接口,最多能传入10,000个设备密钥。超过该限制的数据会被丢弃。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
示例
请求示例
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
}
- 本页导读 (1)
- 使用说明
- 使用限制
- QPS限制
- 调试
- 请求参数
- 返回数据
- 示例