GetDeviceStatus

更新时间:2024-09-14 07:22:25

调用该接口查看指定设备的运行状态。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetDeviceStatus 系统规定参数。取值:GetDeviceStatus。
IotInstanceId String iot_instc_pu****_c*-v64******* 实例ID。您可在物联网平台控制台的实例概览 页面,查看当前实例的ID

注意
+ 若有ID值,必须传入该ID值,否则调用会失败。
+ 若无ID值,则无需传入。
实例的更多信息,请参见实例概述。
ProductKey String a1BwAGV**** 设备所属产品的ProductKey。

** 说明**
如果传入该参数,需同时传入** DeviceName**。
DeviceName String light 设备名称。

** 说明**
如果传入该参数,需同时传入** ProductKey**。
IotId String Q7uOhVRdZRRlDnTLv****00100 设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

说明
如果传入该参数,则无需传入ProductKeyDeviceNameIotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时,返回的错误码。更多信息,请参见错误码。
Data Struct 调用成功时,返回设备状态信息。
Status String ONLINE 设备状态。取值:
+ ONLINE:设备在线。
+ OFFLINE:设备离线。
+ UNACTIVE:设备未激活。
+ DISABLE:设备已禁用。
Timestamp Long 1557062301656 设备状态变更时间。
ErrorMessage String 系统异常 调用失败时,返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 涂鸦云为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。
+ true:调用成功。
+ false:调用失败。

示例

请求示例

https://iot.****.tuya.com.com/?Action=GetDeviceStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共请求参数>

正常返回示例

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "ONLINE",
        "Timestamp": 1557062301656
    },
    "Success": true
}