调用该接口查询指定产品的详细信息。

限制说明

该接口的调用有限流,不得超过50次/秒。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:QueryProduct
ProductKey String 要查询的产品的ProductKeyProductKey是物联网平台为新建产品颁发的产品Key,作为其全局唯一标识符。您可以在创建产品的返回结果中查看该信息。
公共请求参数 - 公共请求参数,请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data Data 调用成功时,返回的数据。详情见表格Data。
表 1. Data
名称 类型 描述
GmtCreate Long 产品创建时间。
DataFormat Integer

高级版产品的数据类型,指设备与云端之间的数据通信协议类型。取值:

0:透传模式。使用自定义的串口数据格式。该模式下,设备可以上报原始数据(如二进制数据流)。阿里云IoT平台会运行您配置在云端的数据解析脚本,将原始数据转换成Alink JSON标准数据格式。

1:Alink JSON。阿里云IoT平台定义的设备与云端的数据交换协议,采用 JSON 格式。

说明 此参数为高级版产品特有参数。
Description String 产品的描述信息。
DeviceCount Integer 该产品下的设备数量。
NodeType Integer

高级版产品的节点类型。取值:

0:设备。设备不能挂载子设备,可以直连IoT Hub,也可以作为网关的子设备连接IoT Hub。

1:网关。网关可以挂载子设备,具有子设备管理模块,维持子设备的拓扑关系,并且可以将拓扑关系同步到云端。

ProductKey String 产品Key。新建产品时,IoT平台为该产品颁发的全局唯一标识。
ProductName String 产品名称。
ProductSecret String 产品秘钥。
CategoryName String 高级版产品的设备类型。取值为您在创建高级版产品时,所选择的设备类型。
CategoryKey String 高级版产品的设备类型的英文标识符。
AliyunCommodityCode String 取值:
  • iothub:物联网平台基础版 。
  • iothub_senior:物联网平台高级版。
Id2 Boolean 该产品是否使用ID²认证。取值:
  • true:使用ID²认证。
  • false:不使用ID²认证。
ProductStatus String 产品状态。
  • DEVELOPMENT_STATUS:开发中。
  • RELEASE_STATUS:产品已发布。
NetType Integer 联网方式。取值:
  • 3:WiFi
  • 6:Cellular (2G/3G/4G)蜂窝网
  • 7:Ethernet 以太网。
  • 8:其他

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=al*********
&公共请求参数

返回示例

  • JSON格式
    {
    	"Data": {
    		"Owner": true,
    		"DataFormat": 1,
    		"CategoryName": "",
    		"ProductStatus": "DEVELOPMENT_STATUS",
    		"ProductKey": "a1*******",
    		"GmtCreate": 1530117156000,
    		"NodeType": 0,
    		"ProductSecret": "i6YZucqlp6******",
    		"ProductName": "protest",
    		"NetType": 3,
    		"DeviceCount": 1,
    		"Id2": false,
    		"AliyunCommodityCode": "iothub_senior"
    	},
    	"RequestId": "E4F94B97-1D64-4080-BFD2-67461667AA43",
    	"Success": true
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8" ?>
    <QueryProductResponse>
    	<Data>
    		<Owner>true</Owner>
    		<DataFormat>1</DataFormat>
    		<CategoryName></CategoryName>
    		<ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
    		<ProductKey>a1*******</ProductKey>
    		<GmtCreate>1530117156000</GmtCreate>
    		<NodeType>0</NodeType>
    		<ProductSecret>i6YZucqlp6******</ProductSecret>
    		<ProductName>protest</ProductName>
    		<NetType>3</NetType>
    		<DeviceCount>1</DeviceCount>
    		<Id2>false</Id2>
    		<AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
    	</Data>
    	<RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    	<Success>true</Success>
    </QueryProductResponse>