调用该接口查询指定产品下多个设备的详细信息。
使用说明
- 单次调用最多能查询100个设备。
- 只能批量查询当前阿里云账号下的设备详情。如果传入的设备信息中,有设备不属于当前账号,则直接返回失败结果。
- 若传入的设备信息中,包含不存在的设备,则只返回存在的设备详情。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchQueryDeviceDetail | 系统规定参数。取值:BatchQueryDeviceDetail。 |
DeviceName.N | RepeatList | 是 | light | 要查询的设备名称列表。最多可包含100个设备名称。 查询的设备必须在同一产品下。 |
ProductKey | String | 是 | a1BwAGV**** | DeviceName.N中设备所属产品的ProductKey。 |
IotInstanceId | String | 否 | iot-v64*** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<公共请求参数>
正常返回示例
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
}