GetDeviceStatus

更新时间:

GetDeviceStatus

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

GetDeviceStatus

系统规定参数。取值:GetDeviceStatus。

IotInstanceId

String

iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

ProductKey

String

a1BwAGV****

设备所属产品的ProductKey。

DeviceName

String

light

设备名称。

IotId

String

Q7uOhVRdZRRlDnTLv****00100

设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

重要

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

返回数据

名称

类型

示例值

描述

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:调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=GetDeviceStatus&SignatureNonce=df49f17269004bbb859b18016bba3cae&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A36%3A03Z&ProductKey=k1ymv1DuLfE&DeviceName=myTestDevice&Signature=P%2Fp35MW02BrnWxrifZSfNidEBuY%3D'

正常返回示例

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