QueryDeviceInfo

更新时间：2024-09-14 06:48:20下载pdf

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	QueryDeviceInfo	系统规定参数。取值：QueryDeviceInfo。
IotInstanceId	String	否	iot-v64***	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。注意 + 若有ID值，必须传入该ID值，否则调用会失败。 + 若无ID值，则无需传入。实例的更多信息，请参见[实例概述]。
ProductKey	String	否	a1BwAGV****	要查询设备所属产品的ProductKey。注意如果传入该参数，需同时传入DeviceName。
DeviceName	String	否	light	要查询设备的设备名称。注意如果传入该参数，需同时传入ProductKey。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	要查询设备的设备ID。注意如果传入该参数，则无需传入 ProductKey和 DeviceName。 IotId作为设备唯一标识符，和 ProductKey与 DeviceName的组合是一一对应的关系。如果您同时传入 IotId和 ProductKey与 DeviceName的组合，则以 IotId为准。

返回数据

名称	类型	示例值	描述
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	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	涂鸦云为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。 + true：调用成功。 + false：调用失败。

示例

请求示例

http(s)://iot.****.tuya.com.com/?Action=QueryDeviceInfo
&ProductKey=a1rYuVF****
&DeviceName=light
&<公共请求参数>

正常返回示例

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "IotId": "Q7uOhVRdZRRlDnTLv****00100",
        "DeviceSecret": "mz2Canp4GB7qRVf1OYPNtRqB2anu****",
        "ProductKey": "a1rYuVF****",
        "Nickname": "detectors_in_beijing",
        "DeviceName": "light"
    },
    "Success": true
}

上一篇BatchUpdateDeviceNickname

下一篇QueryDeviceDetail