調用該接口在MQTT型實例或MQTT云網關產品下批量導入設備。
使用說明
若添加MQTT云網關設備，調用該接口前，請先添加MQTT云網關并成功創建云網關產品，獲取產品的ProductKey。具體操作，請參見創建云網關產品（MQTT）。
QPS限制
單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為10。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
|
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
| Action | String | 是 | BatchImportDevice | 系統規定參數。取值：BatchImportDevice。 |
| ProductKey | String | 是 | a1BwAGV**** | 設備所屬產品的ProductKey。ProductKey是物聯網平臺為產品頒發的全局唯一標識符。您可以在物聯網平臺控制臺或調用QueryProductList，查看當前賬號下所有產品的信息。 |
| DeviceList.N.DeviceName | String | 是 | device1 | 設備的名稱。 設備名稱支持英文字母、數字、短劃線（-）、下劃線（_）、at（@）、英文句號（.）和英文冒號（:），長度限制為4~32個字符。 設備名稱在產品維度下不可重復。 說明 單次調用該接口，最多能傳入10,000個設備名稱。超過該限制的數據會被丟棄。 |
| DeviceList.N.DeviceSecret | String | 是 | b4d43f7******10ba5e5 | 設備的密鑰。 設備密鑰支持英文字母、數字、短劃線（-）、下劃線（_）、at（@）、英文句號（.）和英文冒號（:），長度限制為1~32個字符。 說明 單次調用該接口，最多能傳入10,000個設備密鑰。超過該限制的數據會被丟棄。 |
| DeviceList.N.Sn | String | 否 | QC4******001 | 設備的序列號。 序列號支持英文字母、數字和下劃線（_），長度限制為1~64個字符。 說明 單次調用該接口，最多能傳入10,000個設備序列號。超過該限制的數據會被丟棄。 |
| IotInstanceId | String | 否 | iot-1n8t**** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。 重要
實例的更多信息，請參見實例概述。 |
調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
| Code | String | iot.system.SystemException | 調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。 |
| Data | Struct | 返回的數據。 |
|
| ApplyId | Long | 1295006 | 導入設備成功時，系統返回的申請批次ID。 |
| InvalidDetailList | Array of InvalidDetailList | 導入設備失敗時，不合法設備列表的詳細信息。 |
|
| InvalidDetailList | |||
| DeviceName | String | light% | 設備名稱。 |
| DeviceSecret | String | ^67$ | 設備密鑰。 |
| ErrorMsg | String | The device name is illegal. | 導入設備失敗時，返回的出錯信息。 |
| Sn | String | QC4001# | 設備SN碼。 |
| InvalidDeviceNameList | List | { "InvalidDeviceNameList": [ "APT$", "aw" ] } | 導入設備失敗時，返回的不合法設備名稱的列表。 |
| InvalidDeviceSecretList | List | { "InvalidDeviceSecretList": [ "^67$", "1" ] } | 導入設備失敗時，返回的不合法設備密鑰的列表。 |
| InvalidSnList | List | { "InvalidSnList": [ "" ] } | 導入設備失敗時，返回的不合法設備SN碼的列表。 |
| RepeatedDeviceNameList | List | { "RepeatedDeviceNameList": [ "abcd", "asdf" ] } | 導入設備失敗時，返回的重復設備名稱的列表。 |
| ErrorMessage | String | 系統異常 | 調用失敗時，返回的出錯信息。 |
| RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E | 阿里云為該請求生成的唯一標識符。 |
| Success | Boolean | true | 表示是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchImportDevice
&DeviceList.1.DeviceName=device1
&DeviceList.2.DeviceName=device2
&DeviceList.1.DeviceSecret=b4d43f7******10ba5e5
&DeviceList.2.DeviceSecret=912179******700210b4
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<公共請求參數>正常返回示例
XML格式
<BatchImportDeviceResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Data>
<ApplyId>1295006</ApplyId>
</Data>
<Success>true</Success>
</BatchImportDeviceResponse>JSON格式
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Data": {
"ApplyId": 1295006
},
"Success": true
}