调用该接口根据设备状态查询设备列表。

限制说明

设备状态变更后,新的状态数据会在变更后10秒内生效。变更数据生效后,才能根据新状态查询;变更数据生效前,根据原状态仍能查询到该设备。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值 QueryDeviceByStatus
ProductKey String 设备所属的产品ProductKey,即物联网平台为该产品颁发的唯一标识。
Status Integer 设备状态。 可选值:
  • 0:未激活
  • 1:在线
  • 3:离线
  • 8:已禁用
PageSize Integer 指定返回结果中每页显示的记录数量,最大值是50。
CurrentPage Integer 指定从返回结果中的第几页开始显示。
IotInstanceId String 公共实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 公共请求参数,请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
TotalCount Integer 查询结果中的总记录数。
PageSize Integer 每页显示的记录数。
CurrentPage Integer 当前页码。
TotalPageCount Integer 总页数。
Data Data 调用成功时,返回的设备信息列表。详情参见下表SimpleDeviceInfo。
表 1. SimpleDeviceInfo
名称 类型 描述
ProductKey String 设备所属产品的ProductKey。
DeviceName String 设备名称。
DeviceSecret String 设备密钥。
Nickname String 设备的备注名称。
IotId String 物联网平台为该设备颁发的ID,作为该设备的唯一标识符。
Status String 设备状态。 取值:
  • UNACTIVE:未激活。
  • ONLINE:在线。
  • OFFLINE:离线。
  • DISABLE:已禁用。
GmtCreate String 设备创建时的GMT时间。
GmtModified String 设备信息最后一次修改时的GMT时间。
UtcCreate String 设备创建时的UTC时间。
UtcModified String 设备信息最后一次修改时的UTC时间。

示例

请求示例

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

返回示例

  • JSON格式
    {
      "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
      "Success": true,  
      "CurrentPage": 1, 
      "PageSize": 10, 
      "TotalPageCount": 1,
      "TotalCount": 2,
      "Data": {
        "SimpleDeviceInfo": [
          {
            "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
            "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", 
            "Status": "UNACTIVE", 
            "Nickname": "SensorInShanghai"
          }, 
          {
            "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
            "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", 
            "DeviceStatus": "UNACTIVE", 
            "Nickname": "DriverInShanghai"
          }
        ]
      }  
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8" ?>
    <QueryDeviceByStatusResponse>
        <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
        <Success>true</Success>
        <CurrentPage>1</CurrentPage>
        <PageSize>10</PageSize>
        <TotalPageCount>1</TotalPageCount>
        <TotalCount>2</TotalCount>
        <Data>
            <SimpleDeviceInfo>
                <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
                <DeviceName>Av8NGHGtwPrH9BYGLMBi</DeviceName>
                <ProductKey>a1dafDE****</ProductKey>
                <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
                <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
                <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
                <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
                <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
                <Status>UNACTIVE</Status>
                <Nickname>SensorInShanghai</Nickname>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
                <DeviceName>zNIcSmWQ9BPJlmkjn3H1</DeviceName>
                <ProductKey>a1dafDE****</ProductKey>
                <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
                <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
                <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
                <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
                <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
                <DeviceStatus>UNACTIVE</DeviceStatus>
                <Nickname>DriverInShanghai</Nickname>
            </SimpleDeviceInfo>
        </Data>
    </QueryDeviceByStatusResponse>