QueryDeviceDetail
QueryDeviceDetail
调用该接口查询指定设备的详细信息。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | QueryDeviceDetail | 系统规定参数。取值：QueryDeviceDetail。 |
ProductKey | String | 否 | a1BwAGV**** | 要查询的设备所隶属的产品Key。 |
DeviceName | String | 否 | light | 指定要查询的设备的名称。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查询的设备ID。 |
‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | iot.system.SystemException | 调用失败时，返回的错误码。更多信息，请参见错误码。 |
Data | Struct | 调用成功时，返回设备的详细信息。 | |
DeviceName | String | light | 设备名称。 |
DeviceSecret | String | mz2Canp4GB7qRVf1OYPNtRqB2anu**** | 设备密钥。 |
FirmwareVersion | String | V1.0.0.0 | 设备默认（default）OTA模块的版本号。 |
GmtActive | String | 2018-08-06 10:48:41 | 设备的激活时间，GMT格式。 |
GmtCreate | String | 2018-08-06 10:47:50 | 设备的创建时间，GMT格式。 |
GmtOnline | String | 2018-08-06 13:43:12 | 设备最近一次上线的时间，GMT格式。 |
IotId | String | Q7uOhVRdZRRlDnTLv****00100 | 物联网平台为该设备颁发的ID，作为该设备的唯一标识符。 |
IpAddress | String | 10.0.0.1 | 设备的IP地址。 |
Nickname | String | detectors_in_beijing | 设备的备注名称。 |
NodeType | Integer | 0 | 节点类型，取值：
|
Owner | Boolean | true | API调用者是否是该设备的拥有者。 |
ProductKey | String | a1rYuVF**** | 设备所属产品的ProductKey。 |
ProductName | String | test | 设备所属产品的名称。 |
Region | String | cn-shanghai | 设备所在地区（与控制台上的物联网地平台服务地域对应）。 |
Status | String | ONLINE | 设备状态。取值：
|
UtcActive | String | 2018-08-06T02:48:41.000Z | 设备的激活时间，UTC格式。 |
UtcCreate | String | 2018-08-06T02:47:50.000Z | 设备的创建时间，UTC格式。 |
UtcOnline | String | 2018-08-06T05:43:12.000Z | 设备最近一次上线的时间，UTC格式。 |
ErrorMessage | String | 系统异常 | 调用失败时，返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
te":"2024-11-19 08:17:48","GmtOnline":"1970-01-01 00:00:00","IotId":"ca460d99dfc7981f383f58yrcs","IpAddress":null,"Nickname":"myTestDeviceName","NodeType":0,"Owner":true,"ProductKey":"k1ymv1DuLfE","ProductName":"demo网关","Region":"cn-beijing","Status":"OFFLINE","UtcActive":"2024-11-19T08:17:47.954Z","UtcCreate":"2024-11-19T08:17:48.143Z","UtcOnline":"1970-01-01T00:00:00.000Z"},"RequestId":"3abdf362-2ed1-4a6d-918c-003afcbdbd78","Code":"","Success":true}B正常返回示例
{
"Data": {
"Owner": true,
"GmtActive": "2020-01-16 13:33:37",
"DeviceName": "Humidity",
"ProductKey": "a1ttsqu****",
"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
"IpAddress": "42.120.XX.XXX",
"GmtCreate": "2020-01-08 14:47:08",
"UtcCreate": "2020-01-08T06:47:08.000Z",
"IotId": "dwnS41bhNxjslDAIF****00100",
"Status": "OFFLINE",
"UtcOnline": "2020-01-17T08:19:11.091Z",
"Region": "cn-shanghai",
"UtcActive": "2020-01-16T05:33:37.830Z",
"Nickname": "温湿度",
"NodeType": 0,
"GmtOnline": "2020-01-17 16:19:11",
"ProductName": "光照温湿度传感器"
},
"RequestId": "D2D2DE90-DD0F-44EA-9F56-63F07A59F65B",
"Success": true
}