调用该接口根据申请批次ID（ApplyId）查询批量导入的设备列表。

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. 申请设备的申请单不存在。

访问错误中心查看更多错误码。