本文导读

展开导读

文档首页/ IoT物联网/ API参考/ 北向API参考/ 设备升级/ 查询版本包列表

查询版本包列表

更新时间：2022-02-24 GMT+08:00

查看PDF

典型场景

在进行设备版本升级前，应用服务器可调用此接口查询已经上传到物联网平台的版本升级包列表信息，确保设备要升级的版本包已上传到平台。

接口功能

支持应用服务器在物联网平台查询已上传的版本包列表信息，可根据条件查询满足要求的版本包。

接口原型

请求方法	GET
请求地址	https://server:port/iodm/northbound/v1.5.0/category?fileType={fileType}&deviceType={deviceType}&model={model}&manufactureName={manufactureName}&version={version}
传输协议	HTTPS

请求参数

参数	必选/可选	类型	位置	描述
app_key	必选	String	header	访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。
Authorization	必选	String	header	访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。
fileType	可选	String(256)	query	版本包类型。 firmwarePackage：固件包 softwarePackage：软件包
deviceType	可选	String(256)	query	版本包适用的设备类型。
model	可选	String(256)	query	版本包适用的设备型号。
manufacturerName	可选	String(256)	query	版本包适用的设备厂商名称。
version	可选	String(256)	query	版本包的版本号。
pageNo	可选	Integer	query	分页查询时指定要查询的页码信息，默认值为0，取值范围为大于等于0的整数，值为0时，查询第一页。
pageSize	可选	Integer	query	查询结果分页时的每页结果数量，取值范围1-100，默认值10。

响应参数

Status Code: 200 OK

参数	类型	描述
data	List<CategoryInfo>	版本包列表信息。
pageNo	Integer	查询结果的页码。
pageSize	Integer	查询结果每页的记录数量。
totalCount	Integer	查询结果的总记录数。

CategoryInfo：

参数	类型	描述
fileId	String	版本包ID。
name	String	版本包名称。
version	String	版本包版本号。
fileType	String	版本包文件类型。 firmwarePackage：固件包 softwarePackage：软件包
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?fileType={fileType}&deviceType={deviceType}&model={model}&manufactureName={manufactureName}&version={version}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

响应示例

response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
    "data":[
        {
            "fileId":"****************",
            "name":"******",
            "version":"V1.1.10",
            "fileType":"softwarePackage",
            "deviceType":"******",
            "model":"******",
            "manufacturerName":"***",
            "protocolType":"CoAP",
            "description":"Test software package made by WYH",
            "date":"2017-08-11",
            "uploadTime":"20151212T121212Z"
        },
        {
            "fileId":"****************",
            "name":"******",
            "version":"1.0",
            "fileType":"firmwarePackage",
            "deviceType":"WaterMeter",
            "model":"17",
            "manufacturerName":"******",
            "protocolType":"CoAP",
            "description":null,
            "date":" 2017-11-11",
            "uploadTime":"20151212T121212Z"
        }
    ],
    "pageNo":0,
    "pageSize":2,
    "totalCount":2
}

错误码

Http状态码	错误码	错误描述	说明
400	120015	Bad request error.	请求错误。处理建议：请检查接口请求中pageNo和pageSize的值是否在正常范围内。
400	123029	pageNo or pageSize beyond the limit.	pageNo或pageSize超出上限。处理建议：修改pageNo或pageSize为合法取值。
403	1010009	app throttle exceed.	应用调用接口过于频繁，超过流控值（默认值是100次/60s）。处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。
403	1010005	App_key or access_token is invalid.	错误的token信息。处理建议：请检查接口请求中所携带的accessToken是否有误。

父主题： 设备升级

上一篇：设备升级

下一篇：查询指定版本包

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消