通过QueryDeviceInfo查询指定设备的基本信息_云市场(Marketplace)-阿里云帮助中心

QueryDeviceInfo

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

使用说明

●调用本接口时，必须传入要清空的属性标识符（Identifies）。如果不传入Identifies，调用会失败。 ●单次调用本接口，Identifies最多可传入10个属性标识符。 ●调用本接口清空期望属性值成功后，调用QueryDeviceDesiredProperty接口查询期望属性值时，会返回对应参数Identifier（属性标识符），不会返回对应参数Value了。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	QueryDeviceInfo	系统规定参数。取值：QueryDeviceInfo。
ProductKey	String	否	a1BwAGV****	要查询设备所属产品的ProductKey。
DeviceName	String	否	light	要查询设备的设备名称。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	要查询设备的设备ID。

重要

‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

返回数据

名称	类型	示例值	描述
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：调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=QueryDeviceInfo&SignatureNonce=d34bcbe7150a472e878bea3378cfa3a2&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A30%3A41Z&ProductKey=k1ymv1DuLfE&DeviceName=myTestDevice&Signature=SpyGkZYW3s2QJyJxXtSKbjmaHc8%3D'

正常返回示例

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