查询指定版本包
典型场景
在进行设备版本升级前,应用服务器可调用此接口在物联网平台查询某个版本升级包的信息,确保设备要升级的版本包已上传到平台。
接口功能
支持应用服务器在物联网平台根据版本包ID查询指定版本包信息,在调用该接口前需要通过“查询版本包列表”接口查询获得版本包ID。
接口原型
请求方法 |
GET |
---|---|
请求地址 |
https://server:port/iodm/northbound/v1.5.0/category/{fileId} |
传输协议 |
HTTPS |
请求参数
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
app_key |
必选 |
String |
header |
访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。 |
Authorization |
必选 |
String |
header |
访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。 |
fileId |
必选 |
String |
path |
版本包ID,通过“查询版本包列表”接口查询获得。 |
响应参数
Status Code: 200 OK
参数 |
类型 |
描述 |
---|---|---|
fileId |
String |
版本包ID。 |
name |
String |
版本包名称。 |
version |
String |
版本包的版本号。 |
fileType |
String |
版本包类型。
|
deviceType |
String |
版本包适用的设备类型。 |
model |
String |
版本包适用的设备型号。 |
manufacturerName |
String |
版本包适用的设备厂商名称。 |
protocolType |
String |
版本包适用的设备协议类型。 |
description |
String |
版本包的描述信息。 |
date |
String |
版本包的生成时间。 |
uploadTime |
String |
版本包的上传日期。 |
请求示例
Method: GET request: https://server:port/iodm/northbound/v1.5.0/category/{fileId} Header: app_key: ****** Authorization: Bearer ****** Content-Type: application/json
响应示例
response: Status Code: 200 OK Content-Type: application/json Body: { "fileId": "**********", "name": "******", "version": "V1.1.10", "fileType": "softwarePackage", "deviceType": "******", "model": "******", "manufacturerName": "***", "protocolType": "CoAP", "description": "Test software package made by WYH", "date": "2015-2-2 ", "uploadTime": "20151212T121212Z" }
错误码
Http状态码 |
错误码 |
错误描述 |
说明 |
---|---|---|---|
400 |
120015 |
Bad request error. |
请求错误。 处理建议:请检查接口请求中fileId的格式是否正确。 |
403 |
1010009 |
app throttle exceed. |
应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 |
403 |
1010005 |
App_key or access_token is invalid. |
错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 |
404 |
123002 |
Device or package file not found. |
设备或包不存在。 处理建议:请检查接口请求中的fileId是否正确。 |