BatchGetDeviceState
BatchGetDeviceState
调用该接口批量查看指定设备的运行状态,包括设备当前状态、设备状态变更时间和设备最后一次上线时间等。
使用说明
调用本接口时:
●请求参数同时传入ProductKey和多个DeviceName:查询同一产品多个设备的运行状态。 ●请求参数传入多个IotId:可传入不同产品下设备的IotId,查询不同产品下设备的运行状态。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | BatchGetDeviceState | 系统规定参数。取值:BatchGetDeviceState。 |
DeviceName.N | RepeatList | 否 | light | 要查看运行状态的设备的名称列表。 |
ProductKey | String | 否 | a1BwAGV**** | 要查看运行状态的设备所属的产品ProductKey。 |
IotId.N | RepeatList | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查看运行状态的设备ID列表。 |
‼️ 注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
DeviceStatusList | Array of DeviceStatus | 调用成功时,返回设备状态信息列表,请参见DeviceStatus下的参数。 | |
DeviceStatus | |||
AsAddress | String | 192.0.2.1 | 设备IP地址。 |
DeviceId | String | dwnS41bhNxjslDAI**** | 设备ID(旧版参数)。 |
DeviceName | String | light | 设备名称。 |
IotId | String | dwnS41bhNxjslDAI****000100 | 设备ID,物联网平台为设备颁发的唯一标识。 |
LastOnlineTime | String | 2020-01-17 16:19:11 | 设备最后一次上线的时间。 |
Status | String | OFFLINE | 设备状态。取值:
|
Timestamp | Long | 1557062301656 | 设备状态变更时间。单位为毫秒。 |
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功。
|
示例
请求示例
curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=BatchGetDeviceState&SignatureNonce=49f75ea4eedb42fc871d4038feb1efaa&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&DeviceName.1=myTestDevice&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A37%3A03Z&ProductKey=k1ymv1DuLfE&Signature=JpEmjXliI2FSoMXxATKgmxCoVVA%3D'
正常返回示例
{
"DeviceStatusList": {
"DeviceStatus": [
{
"Status": "OFFLINE",
"DeviceId": "dwnS41bhNxjslDAI****",
"DeviceName": "Humidity",
"AsAddress": "192.0.2.1",
"LastOnlineTime": "2020-01-17 16:19:11",
"Timestamp":1557062301656,
"IotId": "dwnS41bhNxjslDAI****000100"
}
]
},
"RequestId": "3258D872-EDC5-4039-B564-C27ED7176741",
"Success": true
}