QueryImportedDeviceByApplyId - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryImportedDeviceByApplyId	系統規定參數。取值：QueryImportedDeviceByApplyId。
ApplyId	Long	是	1295006	要查詢裝置的申請批次ID。申請批次ID可在BatchImportDevice介面返回結果中查看。
PageNo	Integer	是	1	指定顯示返回結果中的第幾頁，取值範圍為1~10,000。
PageSize	Integer	是	10	指定返回結果中每頁顯示的記錄數量，預設值為10，最大值不超過50。
IotInstanceId	String	否	iot-1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
TotalPage	Integer	100	返回結果的總頁數。
PageNo	Integer	1	顯示返回結果中的第幾頁。
PageSize	Integer	10	返回結果中每頁顯示的記錄數量。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
DeviceList	Array of device		返回的裝置列表資訊。
device
DeviceName	String	light	裝置名稱。重要請妥善保管，勿泄露。
DeviceSecret	String	b4d43f7******10ba5e5	裝置密鑰。重要請妥善保管，勿泄露。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
Sn	String	QC4******001	裝置序號。說明若您沒有為裝置傳入序號，則該參數返回為空白。
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryImportedDeviceByApplyId
&ApplyId=1295006
&PageNo=1
&PageSize=10
&IotInstanceId=iot-1n8t****
&<公用請求參數>

正常返回樣本

XML格式

<QueryImportedDeviceByApplyIdResponse>
  <TotalPage>100</TotalPage>
  <PageSize>10</PageSize>
  <PageNo>1</PageNo>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <ProductKey>a1BwAGV****</ProductKey>
  <DeviceList>
        <device>
              <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
              <Sn>QC4******001</Sn>
              <ProductKey>a1BwAGV****</ProductKey>
              <DeviceName>light</DeviceName>
        </device>
  </DeviceList>
  <Success>true</Success>
</QueryImportedDeviceByApplyIdResponse>

JSON格式

{
    "TotalPage": 100,
    "PageSize": 10,
    "PageNo": 1,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "ProductKey": "a1BwAGV****",
    "DeviceList": {
        "device": {
            "DeviceSecret": "b4d43f7******10ba5e5",
            "Sn": "QC4******001",
            "ProductKey": "a1BwAGV****",
            "DeviceName": "light"
        }
    },
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
200	iot.device.DeviceApplyIsNotFound	The application ID for the device does not exist.	申請裝置的申請單不存在。

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