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

限制说明

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为500。

说明 子账号共享主账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetDeviceStatus

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

IotInstanceId String iot_instc_pu****_c*-v64********

公共实例不传此参数;您购买的实例需传入实例ID。

IotId String Q7uOhVRdZRRlDnTLv****00100

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

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

设备所隶属的产品ProductKey。

说明 如果传入该参数,需同时传入DeviceName
DeviceName String light

设备名称。

说明 如果传入该参数,需同时传入ProductKey

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。错误码详情,请参见错误码

Data Struct

调用成功时,返回设备状态信息。

Status String ONLINE

设备状态。取值:

  • ONLINE:设备在线。
  • OFFLINE:设备离线。
  • UNACTIVE:设备未激活。
  • DISABLE:设备已禁用。
ErrorMessage String 系统异常

调用失败时返回的出错信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

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

正常返回示例

XML 格式

<GetDeviceStatusResponse>
  <Data>
        <Status>OFFLINE</Status>
  </Data>
  <RequestId>902377D7-3C78-48B0-8674-02F43AA86D92</RequestId>
  <Success>true</Success>
</GetDeviceStatusResponse>

JSON 格式

{
	"Data": {
		"Status": "OFFLINE"
	},
	"RequestId": "902377D7-3C78-48B0-8674-02F43AA86D92",
	"Success": true
}