QueryBatchRegisterDeviceStatus - IoT Platform

使用說明

大量註冊裝置時，可調用本介面根據申請批次ID（ApplyId），查看裝置名稱校正結果或註冊結果。

使用自訂裝置名稱大量註冊裝置時，必須先調用本介面確保自訂裝置名稱全部校正通過，再調用BatchRegisterDeviceWithApplyId介面根據對應申請批次ID完成裝置註冊。

說明

如果有校正失敗的裝置名稱，請根據錯誤資訊提示進行修正，然後重新調用BatchCheckDeviceNames介面擷取新的申請批次ID（ApplyId）後，再次調用QueryBatchRegisterDeviceStatus介面確認全部裝置名稱校正通過。
如果返回的Status為CHECK，請耐心等待。大量註冊裝置有一個過程，您可再次調用本介面查看Status確認全部裝置名稱校正通過。

使用自訂裝置名稱大量註冊裝置的完整流程，請參見BatchCheckDeviceNames的使用說明。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryBatchRegisterDeviceStatus	系統規定參數。取值：QueryBatchRegisterDeviceStatus。
ApplyId	Long	是	1295006	要查詢的申請批次ID。申請批次ID在成功調用BatchCheckDeviceNames或BatchRegisterDevice介面的返回結果中。
ProductKey	String	是	a1BwAGV****	要查詢的裝置所屬的產品ProductKey。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。說明目前僅華東2（cn-shanghai）地區支援裝置X.509認證，如果地區不是華東2（cn-shanghai），則不能產生X.509認證，返回錯誤碼iot.device.RegionNotSupportX509。
Data	Struct		調用成功時，返回的狀態資訊。
InvalidDetailList	Array of invalidDetailList		當返回Status參數值為CHECK_FAILED或CREATE_FAILED時，表示有裝置建立失敗，該參數返回建立失敗的裝置的詳情集合。當返回Status參數值為CHECK_SUCCESS或CREATE_SUCCESS時，表示所有裝置建立成功，無需返回失敗詳情，該參數為空白數組。
invalidDetailList
DeviceName	String	light	裝置名稱。
ErrorMsg	String	The nick name is illegal.	建立裝置失敗，返回的出錯資訊。說明多個出錯資訊間使用豎線（\|）隔開。
NickName	String	園區燈-1	裝置的備忘名稱。
InvalidList	List	{ "Name": ["Elec_instrument"] }	當返回Status參數值為CHECK_FAILED或CREATE_FAILED時，表示有裝置建立失敗，該參數返回建立失敗的裝置名稱集合。當返回Status參數值為CHECK_SUCCESS或CREATE_SUCCESS時，表示所有裝置建立成功，無需返回裝置列表，該參數為空白數組。
Status	String	CREATE_SUCCESS	申請單的處理狀態和結果，取值： CHECK：正在校正裝置名稱。 CHECK_SUCCESS：申請單中的所有裝置名稱校正成功。 CHECK_FAILED：申請單中有裝置名稱校正失敗。 CREATE：正在建立裝置。 CREATE_SUCCESS：申請單中的所有裝置建立成功。說明當裝置所屬產品的認證類型是X.509認證時，表示所有裝置和對應的X.509認證都建立成功。 CREATE_FAILED：申請單中有裝置建立失敗。說明當裝置所屬產品的認證類型是X.509時，只要當前批次中，任意一個裝置或X.509認證建立失敗，則返回建立失敗。
ValidList	List	{ "Name": ["light3"] }	當返回Status參數值為CHECK_FAILED或CREATE_FAILED時，表示有裝置建立失敗，該參數返回建立成功的裝置名稱集合。當返回Status參數值為CHECK_SUCCESS或CREATE_SUCCESS時，表示所有裝置建立成功，無需返回裝置列表，該參數為空白數組。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

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

正常返回樣本

XML格式

<QueryBatchCheckDeviceNamesStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>CREATE_SUCCESS</Status>
        <InvalidDetailList>
              <invalidDetailList>
                    <ErrorMsg>The nick name is illegal. | The nick name is illegal.</ErrorMsg>
                    <NickName>園區燈-1</NickName>
                    <DeviceName>Elec_instrument</DeviceName>
              </invalidDetailList>
        </InvalidDetailList>
        <ValidList>
              <Name>light3</Name>
        </ValidList>
        <InvalidList>
              <Name>Elec_instrument</Name>
        </InvalidList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "CREATE_SUCCESS",
        "InvalidDetailList": {
            "invalidDetailList": [{
                "ErrorMsg": "The nick name is illegal. | The nick name is illegal.",
                "NickName": "園區燈-1",
                "DeviceName": "Elec_instrument"
            }]
        },
        "ValidList": {
            "Name": ["light3"]
        },
        "InvalidList": {
            "Name": ["Elec_instrument"]
        }
    },
	"Code": "",
    "Success": true
}

錯誤碼

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