QueryProduct
QueryProduct
调用该接口查询指定产品的详细信息。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | QueryProduct | 系统规定参数。取值:QueryProduct。 |
ProductKey | String | 是 | a1BwAGV**** | 产品的ProductKey。 |
‼️ 注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct | 调用成功时,返回的产品信息详情。 | |
AliyunCommodityCode | String | iothub_senior | 产品类型,决定是否使用物模型功能。 取值:
|
AuthType | String | secret | 产品下的设备接入物联网平台的认证方式。
|
CategoryKey | String | Lighting | 产品所属品类的标识符。 产品使用了物联网平台预定义的标准品类物模型会返回此参数。 |
CategoryName | String | 路灯照明 | 产品所属品类的名称。 产品使用了物联网平台预定义的标准品类物模型会返回此参数。 |
DataFormat | Integer | 1 | 设备与云端之间的数据通信协议类型。 取值:
|
Description | String | 智能路灯 | 产品描述。 |
DeviceCount | Integer | 0 | 该产品下的设备数量。 |
GmtCreate | Long | 1581595942000 | 该产品的创建时间。毫秒级时间戳。 |
Id2 | Boolean | false | 该产品是否使用ID²认证。取值:
|
NetType | Integer | 3 | 产品下设备的联网方式。取值:
|
NodeType | Integer | 0 | 产品的节点类型。取值:
|
Owner | Boolean | true | 调用者是否是产品的拥有者。
|
ProductKey | String | a1T27vz**** | 产品的ProductKey。创建产品时,物联网平台为该产品颁发的全局唯一标识。 |
ProductName | String | 路灯 | 产品名称。 |
ProductSecret | String | U5tW7i44uilc**** | 产品密钥。 |
ProductStatus | String | DEVELOPMENT_STATUS | 产品的状态。
|
ProtocolType | String | modbus | 子设备接入网关的协议类型。产品节点类型为要接入网关的设备的特有参数。取值:
|
ValidateType | Integer | 1 | 数据校验级别。可取值:
数据不展示在物联网平台控制台对应设备的设备详情页物模型数据页签。
|
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 | 该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功。
|
示例
请求示例
curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=QueryProduct&SignatureNonce=e6a6df3e71314699a5dad599a5ab8d29&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T07%3A41%3A29Z&ProductKey=k1ymv1DuLfE&Signature=c8ba39PNDXFuPRIjypMJLu%2FusyE%3D'
正常返回示例
{
"Data": {
"AliyunCommodityCode": "iothub_senior",
"AuthType": "secret",
"CategoryKey": "",
"CategoryName": "",
"DataFormat": 1,
"Description": "",
"DeviceCount": 1,
"GmtCreate": 1731858564256,
"Id2": false,
"NodeType": 0,
"Owner": true,
"ProductKey": "k1ymv1DuLfE",
"ProductName": "demo网关",
"ProductSecret": "",
"ProductStatus": "DEVELOPMENT_STATUS",
"ValidateType": 1
},
"RequestId": "665ab7d2-cdca-4b1b-bd6b-03d5cf7ca36b",
"Code": "",
"Success": true
}