# QueryDeviceByStatus

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

# 使用说明

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

# 请求参数

名称 类型 是否必选 示例值 描述
Action String QueryDeviceByStatus 系统规定参数。取值:QueryDeviceByStatus。
Status Integer 1 设备状态。 可选值: 1 未激活;2 禁用;3 在线; 4 离线
IotInstanceId String 6912917943269**** 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID
ProductKey String a1BwAGV**** 设备所属的产品ProductKey
CurrentPage Integer 1 指定显示返回结果中的第几页的内容。默认值是 1。
PageSize Integer 10 指定返回结果中每页显示的记录数量,最大值是1000000。默认值是10。

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时,返回的错误码。
Data Array of SimpleDeviceInfo 调用成功时,返回的设备信息列表(SimpleDeviceInfo)。
SimpleDeviceInfo
DeviceName String light 设备名称。
DeviceSecret String sLefbFmN9SYfnWLJTePG893XNuRV**** 设备密钥。
GmtCreate String Fri, 21-Mar-2022 10:04:24 GMT 设备创建时的时间,GMT格式。
GmtModified String Fri, 21-Mar-2022 10:04:24 GMT 设备信息最后一次修改时的时间,GMT格式。
IotId String Av8NGHGtwPrH9BYGLMBi00**** 设备ID。
Nickname String SensorInShanghai 设备的备注名称。
ProductKey String a1BwAGV**** 设备所属产品的ProductKey。
Status String ONLINE 设备状态。 取值:UNACTIVE:未激活。ONLINE:在线。OFFLINE:离线。DISABLE:已禁用。
UtcCreate String 2021-02-18T02:46:32.000Z 设备创建时的时间,UTC格式。
UtcModified String 2021-02-18T02:46:32.000Z 设备信息最后一次修改时的时间,UTC格式。
ErrorMessage String 系统异常 调用失败时,返回的出错信息。
Page Integer 1 当前页码。
PageCount Integer 1 总页数。
PageSize Integer 10 每页显示的设备数。
RequestId String xmpDfqSXHINEfo8Zyv0NgCz0OpDsK2M9 平台为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。true:调用成功。false:调用失败。
Total Integer 2 查询到的设备总数。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=QueryDeviceByStatus
&ProductKey=aldafD****
&IotInstanceId=70255861902711****
&Status=1
&PageSize=10
&CurrentPage=1
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <RequestId>FdyjFcyUPS9uF3TWgraMlJoHbc1gHJzx</RequestId>
    <PageCount>2</PageCount>
    <PageSize>2</PageSize>
    <Total>3</Total>
    <Page>1</Page>
    <Data>
        <SimpleDeviceInfo>
            <DeviceName>zNIcSmWQ***</DeviceName>
            <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
            <GmtCreate>Tue, 27-May-2025 06:25:27 GMT</GmtCreate>
            <IotId>71520905555922***</IotId>
            <Nickname>园区灯1</Nickname>
            <ProductKey>byatIkPh***</ProductKey>
            <Status>UNACTIVE</Status>
            <UtcCreate>2025-05-27T06:25:27.000Z</UtcCreate>
        </SimpleDeviceInfo>
        <SimpleDeviceInfo>
            <DeviceName>zNIcSmWQ***</DeviceName>
            <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
            <GmtCreate>Tue, 27-May-2025 06:20:51 GMT</GmtCreate>
            <IotId>71520905555922***</IotId>
            <Nickname>园区灯1</Nickname>
            <ProductKey>byatIkPh***</ProductKey>
            <Status>UNACTIVE</Status>
            <UtcCreate>2025-05-27T06:20:51.000Z</UtcCreate>
        </SimpleDeviceInfo>
    </Data>
    <Success>true</Success>
</xml>

JSON格式

{
  "RequestId": "hNEMKn4M7LmajXMji15EPMTCH1hanYRY",
  "PageCount": 1,
  "PageSize": 10,
  "Total": 3,
  "Page": 1,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "DeviceName": "zNIcSmWQ***",
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****",
        "GmtCreate": "Tue, 27-May-2025 06:25:27 GMT",
        "IotId": "71520905555922***",
        "Nickname": "园区灯1",
        "ProductKey": "a1dafDE****",
        "Status": "UNACTIVE",
        "UtcCreate": "2025-05-27T06:25:27.000Z"
      },
      {
        "DeviceName": "zNIcSmWQ***",
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****",
        "GmtCreate": "Tue, 27-May-2025 06:20:51 GMT",
        "IotId": "71520905555922***",
        "Nickname": "园区灯1",
        "ProductKey": "a1dafDE****",
        "Status": "UNACTIVE",
        "UtcCreate": "2025-05-27T06:20:51.000Z"
      }
    ]
  },
  "Success": true
}