BatchRegisterDevice - IoT Platform

大量註冊裝置方式說明

大量註冊裝置有兩種方式：

由系統隨機產生裝置名稱：調用本介面。

建議按照以下流程註冊裝置和查看結果。

1. 調用本介面大量註冊裝置。返回成功結果，表示大量註冊的申請已經提交成功。實際的註冊是非同步執行，會有一個過程。

2. 調用QueryBatchRegisterDeviceStatus查看裝置註冊結果。

3. 調用QueryPageByApplyId查看大量註冊的裝置資訊（DeviceName、DeviceSecret、IotId）。
自訂裝置名稱：請參見BatchRegisterDeviceWithApplyId。

使用說明

單次調用，最多可建立1,0000個裝置。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為10。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	BatchRegisterDevice	系統規定參數。取值：BatchRegisterDevice。
Count	Integer	是	100	要註冊的裝置數量。說明單次調用，最多可建立10,000個裝置。
ProductKey	String	是	a1BwAGV****	要大量註冊的裝置所隸屬的產品ProductKey。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的資料。
ApplyId	Long	1295006	調用成功時，系統返回的申請批次ID。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDevice
&ProductKey=a1BwAGV****
&Count=10
&<公用請求參數>

正常返回樣本

XML格式

<BatchRegisterDeviceResponse>
  <Data>
        <ApplyId>12345678</ApplyId>
  </Data>
  <RequestId>92C67DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
  <Success>true</Success>
</BatchRegisterDeviceResponse>

JSON格式

{
	"Data": {
		"ApplyId": 12345678
	},
	"RequestId": "92C67DC1-41B5-45F8-9AFD-1FB42448D405",
	"Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。