調用該介面查詢指定產品的詳細資料。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | QueryProduct | 系統規定參數。取值:QueryProduct。 |
| ProductKey | String | 是 | a1BwAGV**** | 要查詢的產品的ProductKey。ProductKey是物聯網平台為建立產品頒發的通用唯一識別碼。您可以在物聯網平台控制台或調用QueryProductList,查看當前帳號下所有產品的資訊。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| Data | Struct | 調用成功時,返回的產品資訊詳情。 |
|
| AliyunCommodityCode | String | iothub_senior | 產品類型,決定是否使用物模型功能。 取值:
|
| AuthType | String | secret | 產品下的裝置接入物聯網平台的認證方式。
|
| CategoryKey | String | Lighting | 產品所屬品類的標識符。 產品使用了物聯網平台預定義的標準品類物模型會返回此參數。 該參數為使用物模型的產品(AliyunCommodityCode=iothub_senior)的特有參數。 |
| CategoryName | String | 路燈照明 | 產品所屬品類的名稱。 產品使用了物聯網平台預定義的標準品類物模型會返回此參數。 該參數為使用物模型的產品(AliyunCommodityCode=iothub_senior)的特有參數。 |
| DataFormat | Integer | 1 | 裝置與雲端之間的資料通訊協定類型。該參數為使用物模型的產品(AliyunCommodityCode=iothub_senior)的特有參數。 取值:
|
| Description | String | 智能路燈 | 產品描述。 |
| DeviceCount | Integer | 0 | 該產品下的裝置數量。 |
| GmtCreate | Long | 1581595942000 | 該產品的建立時間。毫秒級時間戳記。 |
| Id2 | Boolean | false | 該產品是否使用ID²認證。取值:
|
| NetType | Integer | 3 | 產品下裝置的連網方式。取值:
|
| NodeType | Integer | 0 | 產品的節點類型。該參數為使用物模型的產品(AliyunCommodityCode=iothub_senior)的特有參數。取值:
|
| Owner | Boolean | true | 調用者是否是產品的擁有者。
|
| ProductKey | String | a1T27vz**** | 產品的ProductKey。建立產品時,物聯網平台為該產品頒發的全域唯一標識。 |
| ProductName | String | 路燈 | 產品名稱。 |
| ProductSecret | String | U5tW7i44uilc**** | 產品金鑰。 |
| ProductStatus | String | DEVELOPMENT_STATUS | 產品的狀態。
|
| ProtocolType | String | modbus | 子裝置接入網關的協議類型。 此參數為使用物模型的產品(AliyunCommodityCode=iothub_senior),且產品節點類型為要接入網關的裝置的特有參數。取值:
|
| ValidateType | Integer | 1 | 資料校正層級。可取值:
對於2020年10月14日(含當日)之後建立的產品,支援弱校正和免校正。 強校正和弱校正後:
|
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 是否調用成功。
|
樣本
請求樣本
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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。