調用該接口查詢指定產品的詳細信息。

QPS限制

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

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

調試

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

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 QueryProduct

系統規定參數。取值：QueryProduct。
ProductKey String 是 a1BwAGV****

要查詢的產品的ProductKey。ProductKey是物聯網平臺為新建產品頒發的全局唯一標識符。您可以在物聯網平臺控制臺或調用QueryProductList，查看當前賬號下所有產品的信息。

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

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無ID值，則無需傳入。

實例的更多信息，請參見實例概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

Data Struct

調用成功時，返回的產品信息詳情。
AliyunCommodityCode String iothub_senior

產品類型，決定是否使用物模型功能。

取值：

  • iothub_senior：使用物模型。
  • iothub：不使用物模型。
AuthType String secret

產品下的設備接入物聯網平臺的認證方式。

  • secret：使用設備密鑰進行設備身份認證。
  • id2：使用物聯網設備身份認證ID2。
  • x509：使用設備X.509證書進行設備身份認證。
CategoryKey String Lighting

產品所屬品類的標識符。

產品使用了物聯網平臺預定義的標準品類物模型會返回此參數。

該參數為使用物模型的產品（AliyunCommodityCode=iothub_senior）的特有參數。
CategoryName String 路燈照明

產品所屬品類的名稱。

產品使用了物聯網平臺預定義的標準品類物模型會返回此參數。

該參數為使用物模型的產品（AliyunCommodityCode=iothub_senior）的特有參數。
DataFormat Integer 1

設備與云端之間的數據通信協議類型。該參數為使用物模型的產品（AliyunCommodityCode=iothub_senior）的特有參數。

取值：

  • 0：透傳模式。使用自定義的串口數據格式。該模式下，設備可以上報原始數據（如二進制數據流）。阿里云物聯網平臺會運行您配置在云端的數據解析腳本，將原始數據轉換成Alink JSON標準數據格式。
  • 1：Alink JSON。阿里云物聯網平臺定義的設備與云端的數據交換協議，采用 JSON 格式。
Description String 智能路燈

產品描述。
DeviceCount Integer 0

該產品下的設備數量。
GmtCreate Long 1581595942000

該產品的創建時間。毫秒級時間戳。
Id2 Boolean false

該產品是否使用ID2認證。取值：

  • true：使用ID2認證。
  • false：不使用ID2認證。
NetType Integer 3

產品下設備的聯網方式。取值：

  • 3：Wi-Fi。
  • 6：Cellular（2G/3G/4G/5G）蜂窩網。
  • 7：Ethernet以太網。
  • 8：其他。
NodeType Integer 0

產品的節點類型。該參數為使用物模型的產品（AliyunCommodityCode=iothub_senior）的特有參數。取值：

  • 0：設備。設備不能掛載子設備，可以直連IoT Hub，也可以作為網關的子設備連接IoT Hub。
  • 1：網關。網關可以掛載子設備，具有子設備管理模塊，維持子設備的拓撲關系，并且可以將拓撲關系同步到云端。
Owner Boolean true

調用者是否是產品的擁有者。

  • true：是。
  • false：不是。
ProductKey String a1T27vz****

產品的ProductKey。創建產品時，物聯網平臺為該產品頒發的全局唯一標識。
ProductName String 路燈

產品名稱。
ProductSecret String U5tW7i44uilc****

產品密鑰。
ProductStatus String DEVELOPMENT_STATUS

產品的狀態。

  • DEVELOPMENT_STATUS：開發中。
  • RELEASE_STATUS：產品已發布。
ProtocolType String modbus

子設備接入網關的協議類型。

此參數為使用物模型的產品（AliyunCommodityCode=iothub_senior），且產品節點類型為要接入網關的設備的特有參數。取值：

  • modbus：Modbus協議。
  • opc-ua：OPC UA協議。
  • customize：自定義協議。
  • ble：BLE協議。
  • zigbee：ZigBee協議。
ValidateType Integer 1

數據校驗級別。可取值：

  • 2：免校驗。對上報的數據不進行校驗，流轉全量數據。

    數據不展示在物聯網平臺控制臺對應設備的設備詳情頁物模型數據頁簽。

  • 1：弱校驗。只校驗設備數據的idetifier和dataType字段，不校驗其他字段，流轉全量數據。

  • 0：強校驗。校驗所有字段，僅流轉校驗通過的數據。

    對于2020年10月14日之前（不含當日）創建的產品，僅支持強校驗。

對于2020年10月14日（含當日）之后創建的產品，支持弱校驗和免校驗。

強校驗和弱校驗后：

  • 校驗通過的數據展示在物聯網平臺控制臺對應設備的設備詳情頁物模型數據頁簽。校驗不通過的數據則不展示。
  • 通過流轉數據中的參數checkFailedData，可查看校驗不通過的數據，請參見數據格式。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

阿里云為該請求生成的唯一標識符。
Success Boolean true

是否調用成功。

  • true：表示調用成功。
  • false：表示調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<公共請求參數>

正常返回示例

XML格式 

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>路燈照明</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>路燈</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

JSON格式 

{
	"Data": {
		"Owner": true,
		"CategoryName": "路燈照明",
		"DataFormat": 1,
		"ProductKey": "a1BwAGV****",
		"ProductStatus": "DEVELOPMENT_STATUS",
		"GmtCreate": 1581595942000,
		"ProductSecret": "U5tW7i44uilc****",
		"NodeType": 0,
		"ProductName": "路燈",
		"ValidateType":1,
		"DeviceCount": 0,
		"NetType": 3,
		"AuthType": "secret",
		"CategoryKey": "Lighting",
		"Id2": false,
		"AliyunCommodityCode": "iothub_senior"
	},
	"RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
	"Success": true
}