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

限制说明

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为500。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryDeviceInfo

系统规定参数。取值:QueryDeviceInfo。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

无需传入此参数。

ProductKey String a1BwAGV****

要查询设备所属产品的ProductKey。

注意 如果传入该参数,需同时传入 DeviceName
DeviceName String light

要查询设备的设备名称。

注意 如果传入该参数,需同时传入 ProductKey
IotId String Q7uOhVRdZRRlDnTLv****00100

要查询设备的设备ID。

注意 如果传入该参数,则无需传入 ProductKeyDeviceNameIotId作为设备唯一标识符,和 ProductKeyDeviceName的组合是一一对应的关系。如果您同时传入 IotIdProductKeyDeviceName的组合,则以 IotId为准。

调用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:调用失败。

示例

请求示例

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

正常返回示例

XML格式

<QueryDeviceInfoResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
        <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>
        <ProductKey>a1rYuVF****</ProductKey>
        <Nickname>detectors_in_beijing</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceInfoResponse>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
200 Iot.common.QueryDeviceActionError An error occurred while querying the device. 查询设备失败

访问错误中心查看更多错误码。