调用该接口查询指定产品的详细信息。
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
}