调用该接口查询指定产品下的所有设备列表。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:QueryDevice
ProductKey String 要查询的设备所隶属的产品Key。
PageSize Integer 指定返回结果中每页显示的记录数量,最大值是50。默认值是10。
CurrentPage Integer 指定显示返回结果中的第几页的内容。默认值是 1。
IotInstanceId String 公共实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 公共请求参数,请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
PageCount Integer 总页数。
PageSize Integer 每页显示的记录数。
Page Integer 当前页面号。
Total Integer 总记录数。
Data Data 调用成功时,返回设备信息列表。详情参见下表DeviceInfo。
说明 返回的设备信息按照设备创建时间倒序排列。
表 1. DeviceInfo
名称 类型 描述
DeviceId String

设备ID(旧版参数)。

说明 该参数是旧版本遗留参数,已无实际作用,不能用来标识设备。目前,有效的设备标识符为IotIdProductKeyDeviceName组合。
DeviceName String 设备名称。
ProductKey String 设备所属产品Key,即物联网平台为该产品颁发的唯一标识。
DeviceSecret String 设备密钥。
GmtCreate String 设备创建GMT时间。
GmtModified String 设备信息修改GMT时间。
UtcCreate String 设备创建UTC时间。
UtcModified String 设备信息修改UTC时间。
DeviceStatus String 设备状态。
IotId String 设备ID,物联网平台为设备颁发的唯一标识。
Nickname String 设备的备注名称。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevice
&ProductKey=aldafD****
&PageSize=10
&CurrentPage=1
&公共请求参数数

返回示例

  • JSON格式

    {
      "PageCount": 1, 
      "Data": {
        "DeviceInfo": [
          {
            "DeviceId": "Av8NGHGtwPrH9BYG****", 
            "DeviceName": "Av8NGHGtwPrH9BYGLMBi", 
            "ProductKey": "a1dafDE****", 
            "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
            "UtcModified": "2019-02-20T02:16:09.000Z", 
            "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
            "UtcCreate": "2019-02-20T02:16:09.000Z", 
            "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
            "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
            "DeviceStatus": "UNACTIVE", 
            "Nickname": "SensorInShanghai"
          }, 
          {
            "DeviceId": "zNIcSmWQ9BPJlmkj****", 
            "DeviceName": "zNIcSmWQ9BPJlmkjn3H1", 
            "ProductKey": "a1dafDE****", 
            "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
            "UtcModified": "2019-02-20T02:16:09.000Z", 
            "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
            "UtcCreate": "2019-02-20T02:16:09.000Z", 
            "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
            "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
            "DeviceStatus": "UNACTIVE", 
            "Nickname": "DriverInShanghai"
          }
        ]
      }, 
      "Page": 1, 
      "PageSize": 10, 
      "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
      "Success": true, 
      "Total": 2
    }
  • XML格式

    <?xml version="1.0" encoding="UTF-8" ?>
    <QueryDeviceResponse>
        <PageCount>1</PageCount>
        <Data>
            <DeviceInfo>
                <DeviceId>VIjUsKaJsdWqt6nl****</DeviceId>
                <DeviceName>led_device</DeviceName>
                <ProductKey>a1dafDE****</ProductKey>
                <DeviceSecret>qQP6xARs7ky1HuM2reh7y6M4BTdfe****</DeviceSecret>
                <UtcModified>2019-02-19T10:20:14.000Z</UtcModified>
                <GmtCreate>Wed, 30-Jan-2019 11:32:39 GMT</GmtCreate>
                <UtcCreate>2019-01-30T11:32:39.000Z</UtcCreate>
                <GmtModified>Tue, 19-Feb-2019 10:20:14 GMT</GmtModified>
                <DeviceStatus>OFFLINE</DeviceStatus>
                <IotId>nadRfljdEndlfadgadfse****</IotId>
                <Nickname>SensorInShanghai</Nickname>
            </DeviceInfo>
            <DeviceInfo>
                <DeviceId>QwTxRbhFwcaJBad****</DeviceId>
                <DeviceName>led_driver</DeviceName>
                <ProductKey>a1dafDE****</ProductKey>
                <DeviceSecret>6ahkx2cOd0kVPsjnVmxYaGEhMfdf****</DeviceSecret>
                <UtcModified>2019-01-30T11:10:10.000Z</UtcModified>
                <GmtCreate>Wed, 30-Jan-2019 11:10:10 GMT</GmtCreate>
                <UtcCreate>2019-01-30T11:10:10.000Z</UtcCreate>
                <GmtModified>Wed, 30-Jan-2019 11:10:10 GMT</GmtModified>
                <DeviceStatus>UNACTIVE</DeviceStatus>
                <IotId>nadddfRddfaEEadfed****</IotId>
                <Nickname>DriverInShanghai</Nickname>
            </DeviceInfo>
        </Data>
        <PageSize>10</PageSize>
        <RequestId>A4F5820D-E2B3-48D4-AAF8-53FF6A319E27</RequestId>
        <Success>true</Success>
        <Total>2</Total>
    </QueryDeviceResponse>