調用該介面在雲網關產品下大量匯入裝置。
使用說明
本介面適用於大量匯入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格式錯誤。 |
訪問錯誤中心查看更多錯誤碼。