通过QueryDeviceByStatus查询设备列表_云市场(Marketplace)-阿里云帮助中心

QueryDeviceByStatus

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

使用说明

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	QueryDeviceByStatus	系统规定参数。取值：QueryDeviceByStatus。
Status	Integer	是	1	设备状态。可选值： 0：未激活。 1：在线。 3：离线。 8：已禁用。
ProductKey	String	否	a1BwAGV****	设备所属的产品ProductKey。
CurrentPage	Integer	否	1	指定从返回结果中的第几页开始显示。
PageSize	Integer	否	10	指定返回结果中每页显示的记录数量，最大值是50。

重要

‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码
Data	Array of SimpleDeviceInfo		调用成功时，返回的设备信息列表（SimpleDeviceInfo）。
SimpleDeviceInfo
DeviceName	String	light	设备名称。
DeviceSecret	String	sLefbFmN9SYfnWLJTePG893XNuRV****	设备密钥。
GmtCreate	String	2021-02-18 10:46:32	设备创建时的时间，GMT格式。
GmtModified	String	2021-02-18 10:46:32	设备信息最后一次修改时的时间，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	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。 true：调用成功。 false：调用失败。
Total	Integer	2	查询到的设备总数。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Status=0&Action=QueryDeviceByStatus&SignatureNonce=cc5bc1804f5945b7aa7d7ea4defc4d39&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A38%3A25Z&ProductKey=k1ymv1DuLfE&Signature=Xl3HcDIFrKlHFyulTiK%2BCkpUdrQ%3D'

正常返回示例

{
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true,  
  "CurrentPage": 1, 
  "PageSize": 10, 
  "TotalPageCount": 1,
  "TotalCount": 2,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceName": "Av8NGHG***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2021-02-18T02:46:32.000Z", 
        "GmtCreate": "2021-02-18 10:46:32", 
        "UtcCreate": "2021-02-18T02:46:32.000Z", 
        "GmtModified": "2021-02-18 10:46:32", 
        "Status": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceName": "zNIcSmWQ***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2021-02-09T09:44:55.000Z", 
        "GmtCreate": "2021-02-09 17:44:55", 
        "UtcCreate": "2021-02-09T09:44:55.000Z", 
        "GmtModified": "2021-02-09 17:44:55", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }  
}