方舟物联网使用手册

# QueryDeviceInfo

调用该接口查询指定设备的基本信息（设备ID、设备证书和备注名称）。

# 请求参数

# 请求方式1

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

# 请求方式2

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

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时，返回的错误码。
Data Struct 调用成功时，返回设备的基本信息。
DeviceName String light 设备名称。
DeviceSecret String mz2Canp4GB7qRVf1OYPNtRqB2anu**** 设备密钥。
IotId String Q7uOhVRdZRRlDnTLv****00100 物联网平台为该设备颁发的ID，作为该设备的唯一标识符。
Nickname String detectors_in_beijing 设备的备注名称。
ProductKey String a1rYuVF**** 设备所属产品的ProductKey。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
RequestId String cXMiPr3DvbRPnACGpRjtNHEP1yTXML24 平台为该请求生成的唯一标识符。
Success Boolean true 表示是否调用成功。true：调用成功。false：调用失败。

# 示例

请求示例

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

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <RequestId>cXMiPr3DvbRPnACGpRjtNHEP1yTXML24</RequestId>
    <Data>
        <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
        <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>
        <ProductKey>a1rYuVF****</ProductKey>
        <Nickname>detectors_in_beijing</Nickname>
        <DeviceName>light</DeviceName>
    </Data>
    <Success>true</Success>
</xml>

JSON格式

{
  "RequestId": "cXMiPr3DvbRPnACGpRjtNHEP1yTXML24",
  "Data": {
    "IotId": "Q7uOhVRdZRRlDnTLv****00100",
    "DeviceSecret": "mz2Canp4GB7qRVf1OYPNtRqB2anu****",
    "ProductKey": "a1rYuVF****",
    "Nickname": "detectors_in_beijing",
    "DeviceName": "light"
  },
  "Success": true
}

← 查询指定设备的详细信息 →