调用该接口根据AppKey信息查询关联的待配网产品列表。
路径 | /thing/productInfo/getByAppKey |
版本号 | 1.1.7 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
productStatusEnv | String | 否 | dev | 产品状态。dev(表示产品开发中);release(表示产品已发布)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误信息。 |
|
data | JSON |
调用返回的产品信息。 |
|
gmtCreate | Long |
产品创建时间。 |
|
gmtModified | Long |
上一次产品信息变更的时间。 |
|
name | String |
产品名称。 |
|
categoryId | Long |
产品归属品类的ID。 |
|
description | String |
产品描述。 |
|
tenantId | String |
租户ID。 |
|
region | String |
产品所在地域。 |
|
status | Int |
产品状态。0(表示开发中);1(表示已发布)。 |
|
productKey | String |
产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
netType | Int |
产品入网类型:0(表示LoRa);3(表示Wi-Fi);4(表示ZigBee);5(表示Bluetooth);6(表示蜂窝网);7(表示以太网);8(表示其他入网方式)。 |
|
dataFormat | Int |
设备上传的数据格式。0(表示透传/自定义格式);1(表示使用Alink协议数据格式)。 |
|
nodeType | Int |
节点类型。0(表示设备);1(表示网关)。 |
|
categoryKey | String |
产品所属品类的品类标识符。 |
|
categoryName | String |
产品所属品类的名称。 |
|
image | String |
产品的图标。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.1.7"
},
"params":{
"productStatusEnv": "dev"
}
}
正常返回示例
JSON
格式
{
"id": "94e0871c-0770-xxxx-xxxx-e840d86b3ba6",
"code": 200,
"data":[
{
"accessMethod": 0,
"gmtModified": 1515829586000,
"productKey": "a1oOl0IW16u",
"dataFormat": 1,
"netType": 3,
"nodeType": 0,
"gmtCreate": 1515829586000,
"name": "灯",
"tenantId": "D99AEBxxxxxxxxCF008B2DCE1E313",
"region": "cn-shanghai",
"categoryKey":"Light",
"categoryName":"灯",
"status": 0
}
]
}
异常返回示例
JSON
格式
{"code":460,"message":"paramerror"}