根据ProductKey或者IotId查询产品详情
路径 | /vision/product/detail/get |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
productKey | String | 否 | 产品ProductKey | |
iotId | String | 否 | 设备ID |
返回数据
名称 |
类型 |
示例值 |
描述 |
code | Int | 响应码。200: 成功 |
|
message | String | 错误信息 |
|
localizedMsg | String | 本地语言错误信息 |
|
data | JSON | 响应结果 |
|
productKey | String | 产品Key |
|
name | String | 产品名称 |
|
productSecret | String | 产品密钥 |
|
gmtCreate | Long | 创建时间 |
|
netType | String | 产品下设备的联网方式,可取值: NET_LORA(表示LoRa);NET_CELLULAR(表示2G/3G/4G/5G蜂窝网);NET_WIFI(表示Wi-Fi);NET_ZIGBEE(表示ZigBee);NET_ETHERNET(表示以太网);NET_OTHER(表示其他网络类型) |
|
categoryName | String | 品类名称 |
|
categoryKey | String | 品类Key |
|
status | String | 产品状态。DEVELOPMENT_STATUS(表示开发中);RELEASE_STATUS(表示已发布) |
|
nodeType | String | 设备的节点类型:DEVICE,GATEWAY |
|
dataFormat | String | 数据格式。CUSTOM_FORMAT(表示透传/自定义格式);ALINK_FORMAT(表示Alink协议) |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"productKey": "value0",
"iotId": "value1"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": null
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 4047 | invalid param. | 无效的参数 |
该文章对您有帮助吗?