文档首页/ IoT物联网/ API参考/ 应用侧API参考（联通用户专用）/ 设备升级/ 查询版本包列表
更新时间：2023-04-13 GMT+08:00
查看PDF
分享

查询版本包列表

接口说明

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

URI

请求方法

GET

URI

/iodm/northbound/v1.5.0/category

传输协议

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的整数。

pageSize

可选

Integer

query

分页查询参数，查询结果分页显示时每页显示的记录数，默认值为10，取值范围为1-100的整数。

响应参数

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

版本包上传的UTC时间，时间格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

若需要显示本地时区时间，您需要自己进行时间转换。

请求示例

GET https://{host}:{port}/iodm/northbound/v1.5.0/category?fileType={fileType}&deviceType={deviceType}&model={model}&manufactureName={manufactureName}&version={version}
Content-Type: application/json
app_key: ******
Authorization: Bearer ******

正常响应示例

Status Code: 200 OK
Content-Type: application/json

{
    "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

Invalid access token or appId.

错误的token信息。

处理建议：请检查接口请求中所携带的accessToken是否有误。
父主题： 设备升级

相关文档