調用該接口查詢指定設備的基本信息（設備ID、設備證書和備注名稱）。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為500。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
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為準。

調用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
}