全部產品
Search
文件中心

IoT Platform:QueryProduct

更新時間:Feb 11, 2025

調用該介面查詢指定產品的詳細資料。

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:使用物聯網裝置身份認證ID²。
  • 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

該產品是否使用ID²認證。取值:

  • true:使用ID²認證。
  • false:不使用ID²認證。
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
}

錯誤碼

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