調(diào)用該接口查詢指定產(chǎn)品下多個(gè)設(shè)備的詳細(xì)信息。
使用說明
- 單次調(diào)用最多能查詢100個(gè)設(shè)備。
- 只能批量查詢當(dāng)前阿里云賬號(hào)下的設(shè)備詳情。如果傳入的設(shè)備信息中,有設(shè)備不屬于當(dāng)前賬號(hào),則直接返回失敗結(jié)果。
- 若傳入的設(shè)備信息中,包含不存在的設(shè)備,則只返回存在的設(shè)備詳情。
QPS限制
單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)(QPS)最大限制為5。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchQueryDeviceDetail | 系統(tǒng)規(guī)定參數(shù)。取值:BatchQueryDeviceDetail。 |
DeviceName.N | RepeatList | 是 | light | 要查詢的設(shè)備名稱列表。最多可包含100個(gè)設(shè)備名稱。 說明 查詢的設(shè)備必須在同一產(chǎn)品下。 |
ProductKey | String | 是 | a1BwAGV**** | DeviceName.N中設(shè)備所屬產(chǎn)品的ProductKey。 |
IotInstanceId | String | 否 | iot-v64*** | 實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面,查看當(dāng)前實(shí)例的ID。 重要
實(shí)例的更多信息,請(qǐng)參見實(shí)例概述。 |
調(diào)用API時(shí),除了本文介紹的該API的特有請(qǐng)求參數(shù),還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說明,請(qǐng)參見公共參數(shù)文檔。
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException | 調(diào)用失敗時(shí),返回的錯(cuò)誤碼。更多信息,請(qǐng)參見錯(cuò)誤碼。 |
Data | Array of Data | 調(diào)用成功時(shí),返回設(shè)備的詳細(xì)信息。 |
|
Data | |||
DeviceName | String | light | 設(shè)備名稱。 |
DeviceSecret | String | mz2Canp4GB7qRVf1OYPNtRqB2anu**** | 設(shè)備密鑰。 |
FirmwareVersion | String | V1.0.0.0 | 設(shè)備默認(rèn)(default)OTA模塊的版本號(hào)。 如果需要查詢?cè)O(shè)備上報(bào)過的其他OTA模塊版本信息,請(qǐng)參見ListOTAModuleVersionsByDevice。 |
GmtActive | String | 2019-06-21 20:33:00 | 設(shè)備的激活時(shí)間,GMT格式。 |
GmtCreate | String | 2019-06-21 20:31:42 | 設(shè)備的創(chuàng)建時(shí)間,GMT格式。 |
IotId | String | Q7uOhVRdZRRlDnTLv****00100 | 物聯(lián)網(wǎng)平臺(tái)為該設(shè)備頒發(fā)的ID,設(shè)備的唯一標(biāo)識(shí)符。 |
Nickname | String | 智能路燈 | 設(shè)備的備注名稱。 |
NodeType | Integer | 0 | 節(jié)點(diǎn)類型,取值:
|
ProductKey | String | a1BwAGV**** | 設(shè)備所屬產(chǎn)品的ProductKey。 |
ProductName | String | 路燈產(chǎn)品 | 設(shè)備所屬產(chǎn)品的名稱。 |
Region | String | cn-shanghai | 設(shè)備所在地域(與控制臺(tái)上物聯(lián)網(wǎng)平臺(tái)服務(wù)地域?qū)?yīng))。 |
Status | String | ONLINE | 設(shè)備狀態(tài)。取值:
|
UtcActive | String | 2019-06-21T12:31:42.000Z | ?設(shè)備的激活時(shí)間,UTC格式。 |
UtcCreate | String | 2019-06-21T12:31:42.000Z | ?設(shè)備的創(chuàng)建時(shí)間,UTC格式。 |
ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時(shí),返回的出錯(cuò)信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。 |
Success | Boolean | true | 表示是否調(diào)用成功。
|
示例
請(qǐng)求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<公共請(qǐng)求參數(shù)>
正常返回示例
XML
格式
<BatchQueryDeviceDetailResponse>
<Data>
<Data>
<DeviceName>Humidity</DeviceName>
<GmtActive>2020-01-16 13:33:37</GmtActive>
<ProductKey>a1ttsqu****</ProductKey>
<DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
<GmtCreate>2020-01-08 14:47:08</GmtCreate>
<UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
<IotId>dwnS41bhNxjslDAIF****00100</IotId>
<Status>OFFLINE</Status>
<UtcActive>2020-01-08T06:47:08.000Z</UtcActive>
<Region>cn-shanghai</Region>
<Nickname>溫濕度</Nickname>
<NodeType>0</NodeType>
<ProductName>光照溫濕度傳感器</ProductName>
</Data>
<Data>
<Status>OFFLINE</Status>
<GmtActive>2020-01-17 16:23:15</GmtActive>
<DeviceName>TH_sensor</DeviceName>
<Region>cn-shanghai</Region>
<UtcActive>2020-01-17T03:39:14.000Z</UtcActive>
<ProductKey>a1ttsqu****</ProductKey>
<NodeType>0</NodeType>
<DeviceSecret>dCYdTU3gw5Z77bsHjPk6lPHPVnBT****</DeviceSecret>
<ProductName>光照溫濕度傳感器</ProductName>
<GmtCreate>2020-01-17 11:39:14</GmtCreate>
<UtcCreate>2020-01-17T03:39:14.000Z</UtcCreate>
<IotId>RKYkCRstfGBh5SZXL****00100</IotId>
</Data>
</Data>
<RequestId>D4C12DD8-4390-4877-B1DC-4049CF4868BC</RequestId>
<Success>true</Success>
</BatchQueryDeviceDetailResponse>
JSON
格式
{
"Data": {
"Data": [
{
"DeviceName": "Humidity",
"GmtActive": "2020-01-16 13:33:37",
"ProductKey": "a1ttsqu****",
"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
"GmtCreate": "2020-01-08 14:47:08",
"UtcCreate": "2020-01-08T06:47:08.000Z",
"IotId": "dwnS41bhNxjslDAIF****00100",
"Status": "OFFLINE",
"UtcActive": "2020-01-08T06:47:08.000Z",
"Region": "cn-shanghai",
"Nickname": "溫濕度",
"NodeType": 0,
"ProductName": "光照溫濕度傳感器"
},
{
"Status": "OFFLINE",
"GmtActive": "2020-01-17 16:23:15",
"DeviceName": "TH_sensor",
"Region": "cn-shanghai",
"UtcActive": "2020-01-17T03:39:14.000Z",
"ProductKey": "a1ttsqu****",
"NodeType": 0,
"DeviceSecret": "dCYdTU3gw5Z77bsHjPk6lPHPVnBT****",
"ProductName": "光照溫濕度傳感器",
"GmtCreate": "2020-01-17 11:39:14",
"UtcCreate": "2020-01-17T03:39:14.000Z",
"IotId": "RKYkCRstfGBh5SZXL****00100"
}
]
},
"RequestId": "D4C12DD8-4390-4877-B1DC-4049CF4868BC",
"Success": true
}