QueryProduct

更新时间:

QueryProduct

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

QueryProduct

系统规定参数。取值:QueryProduct。

ProductKey

String

a1BwAGV****

产品的ProductKey

重要

‼️ 注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数

返回数据

名称

类型

示例值

描述

Code

String

iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

Data

Struct

调用成功时,返回的产品信息详情。

AliyunCommodityCode

String

iothub_senior

产品类型,决定是否使用物模型功能。

取值:

  • iothub_senior:使用物模型。

AuthType

String

secret

产品下的设备接入物联网平台的认证方式。

  • secret:使用设备密钥进行设备身份认证。

CategoryKey

String

Lighting

产品所属品类的标识符。

产品使用了物联网平台预定义的标准品类物模型会返回此参数。

CategoryName

String

路灯照明

产品所属品类的名称。

产品使用了物联网平台预定义的标准品类物模型会返回此参数。

DataFormat

Integer

1

设备与云端之间的数据通信协议类型。

取值:

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

  • 1:JSON。物联网平台定义的设备与云端的数据交换协议,采用 JSON 格式。

Description

String

智能路灯

产品描述。

DeviceCount

Integer

0

该产品下的设备数量。

GmtCreate

Long

1581595942000

该产品的创建时间。毫秒级时间戳。

Id2

Boolean

false

该产品是否使用ID²认证。取值:

  • true:使用ID²认证。

  • false:不使用ID²认证。

NetType

Integer

3

产品下设备的联网方式。取值:

  • 3:Wi-Fi。

  • 6:Cellular(2G/3G/4G/5G)蜂窝网。

  • 7:Ethernet以太网。

  • 8:其他。

NodeType

Integer

0

产品的节点类型。取值:

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

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

Owner

Boolean

true

调用者是否是产品的拥有者。

  • true:是。

  • false:不是。

ProductKey

String

a1T27vz****

产品的ProductKey。创建产品时,物联网平台为该产品颁发的全局唯一标识。

ProductName

String

路灯

产品名称。

ProductSecret

String

U5tW7i44uilc****

产品密钥。

ProductStatus

String

DEVELOPMENT_STATUS

产品的状态。

  • DEVELOPMENT_STATUS:开发中。

  • RELEASE_STATUS:产品已发布。

ProtocolType

String

modbus

子设备接入网关的协议类型。产品节点类型为要接入网关的设备的特有参数。取值:

  • ble:BLE协议。

  • zigbee:ZigBee协议。

ValidateType

Integer

1

数据校验级别。可取值:

  • 2:免校验。对上报的数据不进行校验,流转全量数据。

数据不展示在物联网平台控制台对应设备的设备详情页物模型数据页签。

  • 1:弱校验。只校验设备数据的idetifier和dataType字段,不校验其他字段,流转全量数据。

ErrorMessage

String

系统异常

调用失败时,返回的出错信息。

RequestId

String

E4F94B97-1D64-4080-BFD2-67461667AA43

该请求生成的唯一标识符。

Success

Boolean

true

是否调用成功。

  • true:表示调用成功。

  • false:表示调用失败。

示例

请求示例

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
}