調用該接口在云網關產品下批量導入設備。
使用說明
本接口適用于批量導入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的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
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協議或SL 651協議云網關設備的設備名稱。 |
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協議或SL 651協議云網關設備失敗時,返回的不合法設備名稱的列表。 |
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協議或SL 651協議云網關設備失敗時,返回的重復設備名稱的列表。 |
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
}