調(diào)用該接口查詢(xún)指定產(chǎn)品的詳細(xì)信息。
QPS限制
單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為50。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
| 名稱(chēng) | 類(lèi)型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryProduct |
系統(tǒng)規(guī)定參數(shù)。取值：QueryProduct。 |
| ProductKey | String | 是 | a1BwAGV**** |
要查詢(xún)的產(chǎn)品的ProductKey。ProductKey是物聯(lián)網(wǎng)平臺(tái)為新建產(chǎn)品頒發(fā)的全局唯一標(biāo)識(shí)符。您可以在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)或調(diào)用QueryProductList，查看當(dāng)前賬號(hào)下所有產(chǎn)品的信息。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面，查看當(dāng)前實(shí)例的ID。 注意
實(shí)例的更多信息，請(qǐng)參見(jiàn)實(shí)例概述。 |
調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明，請(qǐng)參見(jiàn)公共參數(shù)文檔。
返回?cái)?shù)據(jù)
| 名稱(chēng) | 類(lèi)型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException |
調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見(jiàn)錯(cuò)誤碼。 |
| Data | Struct |
調(diào)用成功時(shí)，返回的產(chǎn)品信息詳情。 |
|
| AliyunCommodityCode | String | iothub_senior |
產(chǎn)品類(lèi)型，決定是否使用物模型功能。 取值：
|
| AuthType | String | secret |
產(chǎn)品下的設(shè)備接入物聯(lián)網(wǎng)平臺(tái)的認(rèn)證方式。
|
| CategoryKey | String | Lighting |
產(chǎn)品所屬品類(lèi)的標(biāo)識(shí)符。 產(chǎn)品使用了物聯(lián)網(wǎng)平臺(tái)預(yù)定義的標(biāo)準(zhǔn)品類(lèi)物模型會(huì)返回此參數(shù)。 該參數(shù)為使用物模型的產(chǎn)品（AliyunCommodityCode=iothub_senior）的特有參數(shù)。 |
| CategoryName | String | 路燈照明 |
產(chǎn)品所屬品類(lèi)的名稱(chēng)。 產(chǎn)品使用了物聯(lián)網(wǎng)平臺(tái)預(yù)定義的標(biāo)準(zhǔn)品類(lèi)物模型會(huì)返回此參數(shù)。 該參數(shù)為使用物模型的產(chǎn)品（AliyunCommodityCode=iothub_senior）的特有參數(shù)。 |
| DataFormat | Integer | 1 |
設(shè)備與云端之間的數(shù)據(jù)通信協(xié)議類(lèi)型。該參數(shù)為使用物模型的產(chǎn)品（AliyunCommodityCode=iothub_senior）的特有參數(shù)。 取值：
|
| Description | String | 智能路燈 |
產(chǎn)品描述。 |
| DeviceCount | Integer | 0 |
該產(chǎn)品下的設(shè)備數(shù)量。 |
| GmtCreate | Long | 1581595942000 |
該產(chǎn)品的創(chuàng)建時(shí)間。毫秒級(jí)時(shí)間戳。 |
| Id2 | Boolean | false |
該產(chǎn)品是否使用ID2認(rèn)證。取值：
|
| NetType | Integer | 3 |
產(chǎn)品下設(shè)備的聯(lián)網(wǎng)方式。取值：
|
| NodeType | Integer | 0 |
產(chǎn)品的節(jié)點(diǎn)類(lèi)型。該參數(shù)為使用物模型的產(chǎn)品（AliyunCommodityCode=iothub_senior）的特有參數(shù)。取值：
|
| Owner | Boolean | true |
調(diào)用者是否是產(chǎn)品的擁有者。
|
| ProductKey | String | a1T27vz**** |
產(chǎn)品的ProductKey。創(chuàng)建產(chǎn)品時(shí)，物聯(lián)網(wǎng)平臺(tái)為該產(chǎn)品頒發(fā)的全局唯一標(biāo)識(shí)。 |
| ProductName | String | 路燈 |
產(chǎn)品名稱(chēng)。 |
| ProductSecret | String | U5tW7i44uilc**** |
產(chǎn)品密鑰。 |
| ProductStatus | String | DEVELOPMENT_STATUS |
產(chǎn)品的狀態(tài)。
|
| ProtocolType | String | modbus |
子設(shè)備接入網(wǎng)關(guān)的協(xié)議類(lèi)型。 此參數(shù)為使用物模型的產(chǎn)品（AliyunCommodityCode=iothub_senior），且產(chǎn)品節(jié)點(diǎn)類(lèi)型為要接入網(wǎng)關(guān)的設(shè)備的特有參數(shù)。取值：
|
| ValidateType | Integer | 1 |
數(shù)據(jù)校驗(yàn)級(jí)別。可取值：
對(duì)于2020年10月14日（含當(dāng)日）之后創(chuàng)建的產(chǎn)品，支持弱校驗(yàn)和免校驗(yàn)。 強(qiáng)校驗(yàn)和弱校驗(yàn)后：
|
| ErrorMessage | String | 系統(tǒng)異常 |
調(diào)用失敗時(shí)，返回的出錯(cuò)信息。 |
| RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 |
阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。 |
| Success | Boolean | true |
是否調(diào)用成功。
|
示例
請(qǐng)求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<公共請(qǐng)求參數(shù)>正常返回示例
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
}