BatchGetDeviceState
調(diào)用該接口批量查看指定設備的運行狀態(tài),包括設備當前狀態(tài)、設備狀態(tài)變更時間和設備最后一次上線時間等。
使用說明
調(diào)用本接口時:
- 請求參數(shù)同時傳入ProductKey和多個DeviceName:查詢同一產(chǎn)品多個設備的運行狀態(tài)。
- 請求參數(shù)傳入多個IotId:可傳入不同產(chǎn)品下設備的IotId,查詢不同產(chǎn)品下設備的運行狀態(tài)。
QPS限制
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為50。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | BatchGetDeviceState | 系統(tǒng)規(guī)定參數(shù)。取值:BatchGetDeviceState。 |
DeviceName.N | RepeatList | 否 | light | 要查看運行狀態(tài)的設備的名稱列表。 重要 如果傳入該參數(shù),需同時傳入ProductKey。
|
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
ProductKey | String | 否 | a1BwAGV**** | 要查看運行狀態(tài)的設備所屬的產(chǎn)品ProductKey。 重要 如果傳入該參數(shù),需同時傳入DeviceName。
|
IotId.N | RepeatList | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查看運行狀態(tài)的設備ID列表。 重要 IotId作為設備唯一標識符,和ProductKey與DeviceName組合是一一對應的關系。如果傳入該參數(shù),則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合,則以IotId為準。
|
調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調(diào)用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
DeviceStatusList | Array of DeviceStatus | 調(diào)用成功時,返回設備狀態(tài)信息列表,請參見DeviceStatus下的參數(shù)。 |
|
DeviceStatus | |||
AsAddress | String | 192.0.2.1 | 設備IP地址。 |
DeviceId | String | dwnS41bhNxjslDAI**** | 設備ID(舊版參數(shù))。 說明 該參數(shù)是舊版本遺留參數(shù),已無實際作用,不能用來標識設備。目前,有效的設備標識符為IotId和ProductKey與DeviceName組合。 |
DeviceName | String | light | 設備名稱。 |
IotId | String | dwnS41bhNxjslDAI****000100 | 設備ID,物聯(lián)網(wǎng)平臺為設備頒發(fā)的唯一標識。 |
LastOnlineTime | String | 2020-01-17 16:19:11 | 設備最后一次上線的時間。 |
Status | String | OFFLINE | 設備狀態(tài)。取值:
|
Timestamp | Long | 1557062301656 | 設備狀態(tài)變更時間。單位為毫秒。 |
ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時,返回的出錯信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調(diào)用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchGetDeviceState
&productKey=a1BwAGV****
&DeviceName.1=device1
&DeviceName.2=device2
&<公共請求參數(shù)>
正常返回示例
XML
格式
<BatchGetDeviceStateResponse>
<DeviceStatusList>
<DeviceStatus>
<Status>OFFLINE</Status>
<DeviceId>dwnS41bhNxjslDAI****</DeviceId>
<DeviceName>Humidity</DeviceName>
<AsAddress>192.0.2.1</AsAddress>
<LastOnlineTime>2020-01-17 16:19:11</LastOnlineTime>
<Timestamp>1557062301656</Timestamp>
<IotId>dwnS41bhNxjslDAI****000100</IotId>
</DeviceStatus>
</DeviceStatusList>
<RequestId>3258D872-EDC5-4039-B564-C27ED7176741</RequestId>
<Success>true</Success>
</BatchGetDeviceStateResponse>
JSON
格式
{
"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
}