在鸿云文档

Appearance

queryProduct ​

调用该接口查看产品信息。

使用说明 ​

暂无

接口地址 ​

/gateway/openapi

请求方式 ​

POST

请求参数 ​

请求头 ​

名称类型描述
tokenauthorizationString平台颁发的token
apiCodeString固定值：queryProduct

请求参数 ​

QueryProductRequest ​

名称类型是否必选描述
productKeyString是产品key

返回数据 ​

QueryProductResponse ​

名称类型描述
codeString调用成功，返回0，调用失败，查看错误信息。
msgString调用成功，提示"操作成功"，调用失败，查看错误信息。
dataObject返回结果。结果内容详情，查看下方示例。

result ​

名称类型描述
productIdString产品ID
productKeyString产品Key
productNameString产品名称
productSecretString产品密钥
secretTypeString产品加密类型：
  • TRIPLET-三元组加密
  • ID²-ID²加密
  • CERT-设备证书
linkProtocolString协议类型：
  • MQTT
  • Modbus
  • OPC-UA
  • HTTP
  • TCP
  • 其它
connectModeString连网方式：
  • wifi-WIFI
  • 4G-4G/3G/2G
  • lora-蓝牙
  • ethernet-网线
dataTypeString数据格式：
  • json-JSON
  • binary-二进制码流
deviceAuthModeString设备认证方式 默认secret，secret：密钥认证
productDescString备注
vendorsString厂商
modelString产品型号
dataStatusString数据状态：
  • publish-已发布
  • developing-开发中
createTimeString创建时间：格式为yyyy-MM-dd HH:mm:ss
deviceNumsInteger产品下的所有设备数量
activeNumsInteger激活的设备数量

示例 ​

请求示例 ​

json
{
  "productKey": "T2ahgQhiQ"
}

返回示例 ​

json
{
    "code": "0",
    "msg": "操作成功",
    "data": {
      "productId": "9e080e25ce344e34828c7eb10b5383e1",
      "productKey": "T2ahgQhiQ",
      "productName": "添加产品",
      "productSecret": "e10c4a46876f3462",
      "secretType": "TRIPLET",
      "linkProtocol": "HTTP",
      "connectMode": "wifi",
      "dataType": "json",
      "deviceAuthMode": "secret",
      "productDesc": "开鸿智谷备注",
      "vendors": "开鸿智谷",
      "model": "产品型号",
      "dataStatus": "developing",
      "createTime": "2023-10-10 18:54:12",
      "deviceNums": 0,
      "activeNums": 0
    }
}