QueryDeviceInfo - IoT Platform

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
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
200	Iot.common.QueryDeviceActionError	An error occurred while querying the device.	查詢裝置失敗

訪問錯誤中心查看更多錯誤碼。