調(diào)用該接口根據(jù)申請(qǐng)批次ID（ApplyId）查詢批量導(dǎo)入的設(shè)備列表。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為50。

說(shuō)明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryImportedDeviceByApplyId

系統(tǒng)規(guī)定參數(shù)。取值：QueryImportedDeviceByApplyId。
ApplyId Long 是 1295006

要查詢?cè)O(shè)備的申請(qǐng)批次ID。申請(qǐng)批次ID可在BatchImportDevice接口返回結(jié)果中查看。

PageNo Integer 是 1

指定顯示返回結(jié)果中的第幾頁(yè)，取值范圍為1~10,000。
PageSize Integer 是 10

指定返回結(jié)果中每頁(yè)顯示的記錄數(shù)量，默認(rèn)值為10，最大值不超過50。
IotInstanceId String 否 iot-1n8t****

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面，查看當(dāng)前實(shí)例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無(wú)實(shí)例概覽頁(yè)面或ID值，則無(wú)需傳入。

實(shí)例的更多信息，請(qǐng)參見實(shí)例概述。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明，請(qǐng)參見公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
TotalPage Integer 100

返回結(jié)果的總頁(yè)數(shù)。
PageNo Integer 1

顯示返回結(jié)果中的第幾頁(yè)。
PageSize Integer 10

返回結(jié)果中每頁(yè)顯示的記錄數(shù)量。
RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
ProductKey String a1BwAGV****

設(shè)備所屬產(chǎn)品的ProductKey。

DeviceList Array of device

返回的設(shè)備列表信息。
device
DeviceName String light

設(shè)備名稱。

注意

請(qǐng)妥善保管，勿泄露。
DeviceSecret String b4d43f7******10ba5e5

設(shè)備密鑰。

注意

請(qǐng)妥善保管，勿泄露。
ProductKey String a1BwAGV****

設(shè)備所屬產(chǎn)品的ProductKey。

Sn String QC4******001

設(shè)備序列號(hào)。

說(shuō)明 若您沒有為設(shè)備傳入序列號(hào)，則該參數(shù)返回為空。
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見錯(cuò)誤碼。

ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請(qǐng)求示例

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

正常返回示例

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
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
200 iot.device.DeviceApplyIsNotFound The application ID for the device does not exist. 申請(qǐng)?jiān)O(shè)備的申請(qǐng)單不存在。

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。