BatchRegisterDeviceWithApplyId - IoT Platform

使用說明

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

由系統隨機產生裝置名稱：請調用BatchRegisterDevice介面。
自訂裝置名稱：需本介面與BatchCheckDeviceNames等介面結合實現。請按以下流程操作：

1. 調用BatchCheckDeviceNames介面，傳入要大量註冊的裝置的名稱。物聯網平台檢查您提交的裝置名稱符合要求後，返回申請批次ID（ApplyId）。ApplyId將用於裝置名稱設定結果查詢、批量裝置註冊和裝置資訊查詢。

2. 調用QueryBatchRegisterDeviceStatus查看名稱設定結果。

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

4. （可選）調用QueryBatchRegisterDeviceStatus查看裝置註冊結果。

5. 調用QueryPageByApplyId查看大量註冊的裝置資訊。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	BatchRegisterDeviceWithApplyId	系統規定參數。取值：BatchRegisterDeviceWithApplyId。
ApplyId	Long	是	1295006	要大量註冊的裝置的申請批次ID。申請批次ID由調用BatchCheckDeviceNames介面產生。
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=BatchRegisterDeviceWithApplyId
&ProductKey=alNdd3i****
&ApplyId=1234567
&<公用請求參數>

正常返回樣本

XML格式

<BatchRegisterDeviceWithApplyIdResponse>
  <Data>
        <ApplyId>1234567</ApplyId>
  </Data>
  <RequestId>82C16DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
  <Success>true</Success>
</BatchRegisterDeviceWithApplyIdResponse>

JSON格式

{
	"Data": {
		"ApplyId": 1234567
	},
	"RequestId": "82C16DC1-41B5-45F8-9AFD-1FB42448D405",
	"Success": true
}

錯誤碼

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