# BatchQueryDeviceDetail
调用该接口查询指定产品下多个设备的详细信息。当查询设备名称数量过多时请使用post请求。
# 使用说明
- 单次调用最多能查询100个设备。
- 只能批量查询当前平台账号下的设备详情。如果传入的设备信息中,有设备不属于当前账号,则直接返回失败结果。
- 若传入的设备信息中,包含不存在的设备,则只返回存在的设备详情。
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | BatchQueryDeviceDetail | 系统规定参数。取值:BatchQueryDeviceDetail。 |
| DeviceName.N | RepeatList | 是 | light | 要查询的设备名称列表。最多可包含 100 个设备名称。说明:查询的设备必须在同一产品下。 |
| ProductKey | String | 是 | a1BwAGV**** | DeviceName.N 中设备所属产品的 ProductKey。 |
| IotInstanceId | String | 是 | 6912917943269**** | 实例 ID。您可在物联网平台控制台的 实例概览 页面,查看当前实例的 ID。 |
# 返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException | 调用失败时,返回的错误码。 |
| Data | Array of Data | 调用成功时,返回设备的详细信息。该数组中的每个元素包含以下字段: | |
| Data | |||
| DeviceName | String | light | 设备名称。 |
| DeviceSecret | String | mz2Canp4GB7qRVf1OYPNtRqB2anu**** | 设备密钥。 |
| FirmwareVersion | String | V1.0.0.0 | 设备默认(default)OTA 模块的版本号。 |
| GmtActive | String | Fri, 21-Mar-2022 10:04:24 GMT | 设备的激活时间,GMT 格式。 |
| GmtCreate | String | Fri, 21-Mar-2022 10:04:24 GMT | 设备的创建时间,GMT 格式。 |
| IotId | String | Q7uOhVRdZRRlDnTLv****00100 | 物联网平台为该设备颁发的 ID,设备的唯一标识符。 |
| Nickname | String | 智能路灯 | 设备的备注名称。 |
| NodeType | Integer | 0 | 节点类型,取值:0:设备。设备不能挂载子设备。可以直连物联网平台,也可以作为网关的子设备连接物联网平台。 |
| ProductKey | String | a1BwAGV**** | 设备所属产品的 ProductKey。 |
| ProductName | String | 路灯产品 | 设备所属产品的名称。 |
| Region | String | huadong2 | 设备所在地域(与控制台上物联网平台服务地域对应)。 |
| Status | String | ONLINE | 设备状态。取值:ONLINE:设备在线;OFFLINE:设备离线;UNACTIVE:设备未激活;DISABLE:设备已禁用。 |
| UtcActive | String | 2019-06-21T12:31:42.000Z | 设备的激活时间,UTC 格式。 |
| UtcCreate | String | 2019-06-21T12:31:42.000Z | 设备的创建时间,UTC 格式。 |
| ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
| RequestId | String | CnOkxck1jCXvT94LT3YJiis0joJE4OCH | 平台为该请求生成的唯一标识符。 |
| Success | Boolean | true | 表示是否调用成功。true:调用成功;false:调用失败。 |
# 示例
请求示例
http://open.${区域}.fenydata.com/fenydata-java-open/?Action=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&IotInstanceId=70255861902711****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<公共请求参数>
正常返回示例
XML格式
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
<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>huadong2</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>huadong2</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>CnOkxck1jCXvT94LT3YJiis0joJE4OCH</RequestId>
<Success>true</Success>
</xml>
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": "huadong2",
"Nickname": "温湿度",
"NodeType": 0,
"ProductName": "光照温湿度传感器"
},
{
"Status": "OFFLINE",
"GmtActive": "2020-01-17 16:23:15",
"DeviceName": "TH_sensor",
"Region": "huadong2",
"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": "CnOkxck1jCXvT94LT3YJiis0joJE4OCH",
"Success": true
}