方舟物联网使用手册

# QueryDeviceDetail

调用该接口查询指定设备的详细信息。

# 请求参数

# 请求方式1

名称 类型 是否必选 示例值 描述
Action String 是 QueryDeviceDetail 系统规定参数。取值：QueryDeviceDetail。
IotInstanceId String 是 70255861902711*** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
ProductKey String 是 a1BwAGV**** 要查询的设备所隶属的产品Key。
DeviceName String 是 light 指定要查询的设备的名称。

# 请求方式2

名称 类型 是否必选 示例值 描述
Action String 是 QueryDeviceDetail 系统规定参数。取值：QueryDeviceDetail。
IotInstanceId String 是 70255861902711*** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
IotId String 是 70255861902711**** 要查询的设备ID。

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时，返回的错误码。
Data Struct 调用成功时，返回设备的详细信息。
DeviceName String light 设备名称。
DeviceSecret String mz2Canp4GB7qRVf1OYPNtRqB2anu**** 设备密钥。
FirmwareVersion String V1.0.0.0 设备默认（default）OTA模块的版本号。
GmtActive String Wed, 20-Feb-2019 02:16:09 GMT 设备的激活时间，GMT格式。
GmtCreate String Wed, 20-Feb-2019 02:16:09 GMT 设备的创建时间，GMT格式。
GmtOnline String Wed, 20-Feb-2019 02:16:09 GMT 设备最近一次上线的时间，GMT格式。
IotId String 70255861902711**** 物联网平台为该设备颁发的ID，作为该设备的唯一标识符。
IpAddress String 10.0.0.1 设备的IP地址。
Nickname String detectors_in_beijing 设备的备注名称。
NodeType Integer 0 节点类型，取值：0：设备。
Owner Boolean true API调用者是否是该设备的拥有者。
ProductKey String a1rYuVF**** 设备所属产品的ProductKey。
ProductName String test 设备所属产品的名称。
Region String huadong2 设备所在地区（与控制台上的物联网地平台服务地域对应）。
Status String ONLINE 设备状态。取值：ONLINE：设备在线。OFFLINE：设备离线。UNACTIVE：设备未激活。DISABLE：设备已禁用。
UtcActive String 2019-02-20T02:16:09.000Z 设备的激活时间，UTC格式。
UtcCreate String 2019-02-20T02:16:09.000Z 设备的创建时间，UTC格式。
UtcOnline String 2019-02-20T02:16:09.000Z 设备最近一次上线的时间，UTC格式。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
RequestId String j0LH2AbUOVu0MH3Z28C4YVk5ynRmrqYz 平台为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。true：调用成功。false：调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=QueryDeviceDetail
&IotInstanceId=70255861902711***
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <Data>
        <Owner>true</Owner>
        <GmtActive>Wed, 20-Feb-2019 02:16:09 GMT</GmtActive>
        <DeviceName>Humidity</DeviceName>
        <ProductKey>a1ttsqu****</ProductKey>
        <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
        <IpAddress>42.120.75.144</IpAddress>
        <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
        <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
        <IotId>dwnS41bhNxjslDAIF****00100</IotId>
        <Status>OFFLINE</Status>
        <UtcOnline>2019-02-20T02:16:09.000Z</UtcOnline>
        <Region>huadong2</Region>
        <UtcActive>2019-02-20T02:16:09.000Z</UtcActive>
        <Nickname>温湿度</Nickname>
        <NodeType>0</NodeType>
        <GmtOnline>Wed, 20-Feb-2019 02:16:09 GMT</GmtOnline>
        <ProductName>光照温湿度传感器</ProductName>
    </Data>
    <RequestId>j0LH2AbUOVu0MH3Z28C4YVk5ynRmrqYz</RequestId>
    <Success>true</Success>
</xml>

JSON格式

{
  "Data": {
    "Owner": true,
    "GmtActive": "Wed, 20-Feb-2019 02:16:09 GMT",
    "DeviceName": "Humidity",
    "ProductKey": "a1ttsqu****",
    "DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
    "IpAddress": "42.120.75.144",
    "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT",
    "UtcCreate": "2019-02-20T02:16:09.000Z",
    "IotId": "dwnS41bhNxjslDAIF****00100",
    "Status": "OFFLINE",
    "UtcOnline": "2019-02-20T02:16:09.000Z",
    "Region": "huadong2",
    "UtcActive": "2019-02-20T02:16:09.000Z",
    "Nickname": "温湿度",
    "NodeType": 0,
    "GmtOnline": "Wed, 20-Feb-2019 02:16:09 GMT",
    "ProductName": "光照温湿度传感器"
  },
  "RequestId": "j0LH2AbUOVu0MH3Z28C4YVk5ynRmrqYz",
  "Success": true
}

← 查询指定产品下多个设备的详细信息 →