固件管理

固件上传

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upload

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
productKey	string	是	ProductKey。产品Key
version	string	是	固件版本号
alg	string	否	签名算法
signature	string	否	签名
filename	string	是	文件名
downloadUrl	string	是	下载地址
size	long	是	文件大小
sha256Hash	string	否	sha256 hash
packageType	int	是	包类型。1 全量；2 拆分
baseVersion	string	否	拆分包基础版本号
remark	string	否	备注

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+id	long	是	固件ID

响应样例

json

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": 123456
  }
}

固件详情

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/get

方法

GET

请求参数

参数	数据类型	必填	说明
id	long	是	固件ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+id	long	是	固件ID
+productKey	string	是	产品Key
+model	string	是	产品型号
+version	string	是	固件版本号
+alg	string	否	签名算法
+signature	string	否	签名
+filename	string	是	文件名
+downloadUrl	string	是	下载地址
+size	long	是	文件大小
+sha256Hash	string	否	sha256 hash
+packageType	int	是	包类型。1 全量；2 拆分
+baseVersion	string	否	拆分包基础版本号
+remark	string	否	备注
+status	int	是	固件状态。0 不可用； 1 可用
+createAt	string	是	创建时间
+updateAt	string	是	更新时间

响应样例

json


  {
    "code": 200,
    "msg": "success",
    "data": {
      "id": 123456,
      "productKey": "a1b2c3d4e5f6",
      "model": "SmartDevice-X1",
      "version": "2.0.0",
      "alg": "RSA-SHA256",
      "signature": "a1b2c3d4e5f6...",
      "filename": "firmware_v2.0.0.bin",
      "downloadUrl": "https://cdn.thingshub.com.cn/firmware/a1b2c3d4e5f6/firmware_v2.0.0.bin",
      "size": 1048576,
      "sha256Hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "packageType": 1,
      "baseVersion": null,
      "remark": "固件版本更新",
      "status": 1,
      "createAt": "2024-01-15 10:30:00",
      "updateAt": "2024-01-15 10:30:00"
    }
  }

固件列表查询（分页）

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/list

方法

GET

Content-Type

无

请求参数

参数	数据类型	必填	说明
productKey	string	否	ProductKey
packageType	int	否	包类型。1 全量；2 拆分
status	int	否	固件状态。0 不可用； 1 可用
current	int	否	页码，默认1
size	int	否	页大小，默认10

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+total	long	是	总记录数
+records	array	是	固件列表
++id	long	是	固件ID
++productKey	string	是	产品Key
++model	string	是	产品型号
++version	string	是	固件版本号
++alg	string	否	签名算法
++signature	string	否	签名
++filename	string	是	文件名
++downloadUrl	string	是	下载地址
++size	long	是	文件大小
++sha256Hash	string	是	sha256 hash
++packageType	int	是	包类型。1 全量；2 拆分
++baseVersion	string	否	拆分包基础版本号
++remark	string	否	备注
++status	int	是	固件状态。0 不可用； 1 可用
++createAt	string	是	创建时间
++updateAt	string	是	更新时间

响应样例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "total": 100,
    "records": [
      {
        "id": 123456,
        "productKey": "a1b2c3d4e5f6",
        "model": "SmartDevice-X1",
        "version": "2.0.0",
        "alg": "RSA-SHA256",
        "signature": "a1b2c3d4e5f6...",
        "filename": "firmware_v2.0.0.bin",
        "downloadUrl": "https://cdn.thingshub.com.cn/firmware/a1b2c3d4e5f6/firmware_v2.0.0.bin",
        "size": 1048576,
        "sha256Hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "packageType": 1,
        "baseVersion": null,
        "remark": "固件版本更新",
        "status": 1,
        "createAt": "2024-01-15 10:30:00",
        "updateAt": "2024-01-15 10:30:00"
      }
    ]
  }
}

固件更新

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/update

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
id	long	是	固件ID
productKey	string	是	ProductKey。产品Key
version	string	是	固件版本号
alg	string	否	签名算法
signature	string	否	签名
filename	string	是	文件名
downloadUrl	string	是	下载地址
size	long	是	文件大小
sha256Hash	string	是	sha256 hash
packageType	int	是	包类型。1 全量；2 拆分
baseVersion	string	否	拆分包基础版本号
remark	string	否	备注
status	int	是	固件状态。0 不可用； 1 可用

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

json

{
  "code": 200,
  "msg": "success"
}

固件删除

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/delete

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
id	long	是	固件ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

json

{
  "code": 200,
  "msg": "success"
}

创建固件升级任务

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/create

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
taskName	string	是	任务名称
productKey	string	是	ProductKey。产品Key
firmwareId	long	是	固件ID
deviceList	array	是	设备名称列表
retryCount	int	否	重试次数，默认3
retryInterval	int	否	重试间隔（分钟），默认10
timeout	int	否	超时时间（分钟），默认60
startTime	string	否	定时执行时间，格式：yyyy-MM-dd HH:mm:ss
policyId	long	否	策略ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+taskId	string	是	升级任务ID

响应样例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "123456"
  }
}

删除固件升级任务

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/delete

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
taskId	string	是	升级任务ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

json

{
  "code": 200,
  "msg": "success"
}

修改固件升级任务

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/update

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
taskId	string	是	升级任务ID
taskName	string	否	任务名称
firmwareId	long	否	固件ID
deviceList	array	否	设备名称列表
retryCount	int	否	重试次数
retryInterval	int	否	重试间隔（分钟）
timeout	int	否	超时时间（分钟）
startTime	string	否	定时执行时间，格式：yyyy-MM-dd HH:mm:ss
policyId	long	否	策略ID
status	int	否	任务状态。0 禁用；1 启用

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

json

{
  "code": 200,
  "msg": "success"
}

获取升级任务详情

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/get

方法

GET

请求参数

参数	数据类型	必填	说明
taskId	string	是	升级任务ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+taskId	string	是	升级任务ID
+taskName	string	是	任务名称
+productKey	string	是	ProductKey。产品Key
+firmwareId	long	是	固件ID
+deviceList	array	是	设备名称列表
+retryCount	int	是	重试次数
+retryInterval	int	是	重试间隔（分钟）
+timeout	int	是	超时时间（分钟）
+startTime	string	否	定时执行时间，格式：yyyy-MM-dd HH:mm:ss
+policyId	long	否	策略ID
+status	int	是	任务状态。0 禁用；1 启用
+createAt	string	是	创建时间
+updateAt	string	是	更新时间

响应样例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "123456",
    "taskName": "升级任务1",
    "productKey": "123456",
    "firmwareId": 123456,
    "deviceList": [
      "设备1",
      "设备2"
    ],
    "retryCount": 3,
    "retryInterval": 10,
    "timeout": 60,
    "startTime": "2023-01-01 00:00:00",
    "policyId": 123456,
    "status": 0,
    "createAt": "2023-01-01 00:00:00",
    "updateAt": "2023-01-01 00:00:00"
  }
}

升级任务列表查询（分页）

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/list

方法

GET

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
productKey	string	是	ProductKey。产品Key
taskName	string	否	任务名称
status	int	否	任务状态。0 禁用；1 启用
current	int	否	页码，默认1
size	int	否	页大小，默认10

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+total	long	是	总记录数
+records	array	是	升级任务列表
++taskId	string	是	升级任务ID
++taskName	string	是	任务名称
++productKey	string	是	ProductKey。产品Key
++firmwareId	long	是	固件ID
++deviceList	array	是	设备名称列表
++retryCount	int	是	重试次数
++retryInterval	int	是	重试间隔（分钟）
++timeout	int	是	超时时间（分钟）
++startTime	string	否	定时执行时间，格式：yyyy-MM-dd HH:mm:ss
++policyId	long	否	更新策略ID
++status	int	是	任务状态。0 禁用；1 启用
++createAt	string	是	创建时间
++updateAt	string	是	更新时间

响应样例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "total": 1,
    "records": [
      {
        "taskId": "123456",
        "taskName": "升级任务1",
        "productKey": "123456",
        "firmwareId": 123456,
        "deviceList": [
          "设备1",
          "设备2"
        ],
        "retryCount": 3,
        "retryInterval": 10,
        "timeout": 60,
        "startTime": "2023-01-01 00:00:00",
        "policyId": 123456,
        "status": 0,
        "createAt": "2023-01-01 00:00:00",
        "updateAt": "2023-01-01 00:00:00"
      }
    ]
  }
}

升级日志详情

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/log/get

方法

GET

请求参数

参数	数据类型	必填	说明
logId	long	是	日志ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+logId	long	是	日志ID
+taskId	string	是	升级任务ID
+taskName	string	是	任务名称
+productKey	string	是	ProductKey。产品Key
+firmwareId	long	是	固件ID
+deviceName	string	是	设备名称
+status	int	是	升级状态。0 待升级；1 升级中；2 升级成功；3 升级失败；4 已取消
+progress	int	是	升级进度，0-100
+currentVersion	string	否	当前版本号
+targetVersion	string	否	目标版本号
+errorMsg	string	否	错误信息
+retryCount	int	是	已重试次数
+startTime	string	否	开始时间，格式：yyyy-MM-dd HH:mm:ss
+endTime	string	否	结束时间，格式：yyyy-MM-dd HH:mm:ss
+createAt	string	是	创建时间
+updateAt	string	是	更新时间

响应样例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "logId": 123456,
    "taskId": "123456",
    "taskName": "升级任务1",
    "productKey": "a1b2c3d4e5f6",
    "firmwareId": 123456,
    "deviceName": "设备1",
    "status": 2,
    "progress": 100,
    "currentVersion": "1.0.0",
    "targetVersion": "2.0.0",
    "errorMsg": null,
    "retryCount": 0,
    "startTime": "2024-01-15 10:30:00",
    "endTime": "2024-01-15 10:35:00",
    "createAt": "2024-01-15 10:30:00",
    "updateAt": "2024-01-15 10:35:00"
  }
}

升级日志分页查询

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/upgrade/log/list

方法

GET

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
taskId	string	否	升级任务ID
productKey	string	否	ProductKey。产品Key
deviceName	string	否	设备名称
status	int	否	升级状态。0 待升级；1 升级中；2 升级成功；3 升级失败；4 已取消
current	int	否	页码，默认1
size	int	否	页大小，默认10

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+total	long	是	总记录数
+list	array	是	升级日志列表
++logId	long	是	日志ID
++taskId	string	是	升级任务ID
++taskName	string	是	任务名称
++productKey	string	是	ProductKey。产品Key
++firmwareId	long	是	固件ID
++deviceName	string	是	设备名称
++status	int	是	升级状态。0 待升级；1 升级中；2 升级成功；3 升级失败；4 已取消
++progress	int	是	升级进度，0-100
++currentVersion	string	否	当前版本号
++targetVersion	string	否	目标版本号
++errorMsg	string	否	错误信息
++retryCount	int	是	已重试次数
++startTime	string	否	开始时间，格式：yyyy-MM-dd HH:mm:ss
++endTime	string	否	结束时间，格式：yyyy-MM-dd HH:mm:ss
++createAt	string	是	创建时间
++updateAt	string	是	更新时间

响应样例

json

{}

创建升级策略

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/policy/create

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
policyName	string	是	策略名称
productKey	string	是	ProductKey。产品Key
description	string	否	策略描述
upgradeMode	int	是	升级模式。1 静默升级；2 用户确认升级
pushMode	int	是	推送模式。1 立即推送；2 定时推送
pushTime	string	否	定时推送时间，格式：yyyy-MM-dd HH:mm:ss，pushMode为2时必填
retryPolicy	int	是	重试策略。1 不重试；2 固定间隔重试；3 指数退避重试
retryCount	int	否	重试次数，retryPolicy不为1时必填，默认3
retryInterval	int	否	重试间隔（分钟），retryPolicy为2时必填，默认10
maxRetryInterval	int	否	最大重试间隔（分钟），retryPolicy为3时必填
timeout	int	是	单设备升级超时时间（分钟），默认60
concurrentLimit	int	是	并发限制，同时升级设备数量，默认100
priority	int	是	优先级。1 低；2 中；3 高，默认2
autoRollback	int	否	自动回滚。0 否；1 是，默认0
rollbackVersion	long	否	回滚版本固件ID，autoRollback为1时必填
condition	string	否	升级条件，JSON格式

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+policyId	long	是	策略ID

响应样例

json

{}

删除升级策略

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/policy/delete

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
policyId	long	是	策略ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据

响应样例

json

{
  "code": 200,
  "msg": "success"
}

修改升级策略

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/policy/update

方法

POST

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
policyId	long	是	策略ID
policyName	string	否	策略名称
description	string	否	策略描述
upgradeMode	int	否	升级模式。1 静默升级；2 用户确认升级
pushMode	int	否	推送模式。1 立即推送；2 定时推送
pushTime	string	否	定时推送时间，格式：yyyy-MM-dd HH:mm:ss，pushMode为2时必填
retryPolicy	int	否	重试策略。1 不重试；2 固定间隔重试；3 指数退避重试
retryCount	int	否	重试次数，retryPolicy不为1时必填
retryInterval	int	否	重试间隔（分钟），retryPolicy为2时必填
maxRetryInterval	int	否	最大重试间隔（分钟），retryPolicy为3时必填
timeout	int	否	单设备升级超时时间（分钟）
concurrentLimit	int	否	并发限制，同时升级设备数量
priority	int	否	优先级。1 低；2 中；3 高
autoRollback	int	否	自动回滚。0 否；1 是
rollbackVersion	long	否	回滚版本固件ID，autoRollback为1时必填
condition	string	否	升级条件，JSON格式
status	int	否	策略状态。0 禁用；1 启用

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据

响应样例

json

{
  "code": 200,
  "msg": "success"
}

升级策略详情

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/policy/get

方法

GET

请求参数

参数	数据类型	必填	说明
policyId	long	是	策略ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+policyId	long	是	策略ID
+policyName	string	是	策略名称
+productKey	string	是	ProductKey。产品Key
+description	string	否	策略描述
+upgradeMode	int	是	升级模式。1 静默升级；2 用户确认升级
+pushMode	int	是	推送模式。1 立即推送；2 定时推送
+pushTime	string	否	定时推送时间，格式：yyyy-MM-dd HH:mm:ss
+retryPolicy	int	是	重试策略。1 不重试；2 固定间隔重试；3 指数退避重试
+retryCount	int	是	重试次数
+retryInterval	int	否	重试间隔（分钟）
+maxRetryInterval	int	否	最大重试间隔（分钟）
+timeout	int	是	单设备升级超时时间（分钟）
+concurrentLimit	int	是	并发限制，同时升级设备数量
+priority	int	是	优先级。1 低；2 中；3 高
+autoRollback	int	是	自动回滚。0 否；1 是
+rollbackVersion	long	否	回滚版本固件ID
+condition	string	否	升级条件，JSON格式
+status	int	是	策略状态。0 禁用；1 启用
+createAt	string	是	创建时间
+updateAt	string	是	更新时间

响应样例

json

{}

升级策略列表分页查询

请求URL

https://www.thingshub.com.cn/openapi/v2/fireware/policy/list

方法

GET

Content-Type

application/json

请求参数

参数	数据类型	必填	说明
productKey	string	是	ProductKey。产品Key
policyName	string	否	策略名称
upgradeMode	int	否	升级模式。1 静默升级；2 用户确认升级
pushMode	int	否	推送模式。1 立即推送；2 定时推送
retryPolicy	int	否	重试策略。1 不重试；2 固定间隔重试；3 指数退避重试
priority	int	否	优先级。1 低；2 中；3 高
status	int	否	策略状态。0 禁用；1 启用
current	int	否	页码，默认1
size	int	否	页大小，默认10

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	否	返回数据
+total	long	是	总记录数
+list	array	是	升级策略列表
++strategyId	long	是	策略ID
++strategyName	string	是	策略名称
++productKey	string	是	ProductKey。产品Key
++description	string	否	策略描述
++upgradeMode	int	是	升级模式。1 静默升级；2 用户确认升级
++pushMode	int	是	推送模式。1 立即推送；2 定时推送
++pushTime	string	否	定时推送时间，格式：yyyy-MM-dd HH:mm:ss
++retryPolicy	int	是	重试策略。1 不重试；2 固定间隔重试；3 指数退避重试
++retryCount	int	是	重试次数
++retryInterval	int	否	重试间隔（分钟）
++maxRetryInterval	int	否	最大重试间隔（分钟）
++timeout	int	是	单设备升级超时时间（分钟）
++concurrentLimit	int	是	并发限制，同时升级设备数量
++priority	int	是	优先级。1 低；2 中；3 高
++autoRollback	int	是	自动回滚。0 否；1 是
++rollbackVersion	long	否	回滚版本固件ID
++condition	string	否	升级条件，JSON格式
++status	int	是	策略状态。0 禁用；1 启用
++createAt	string	是	创建时间
++updateAt	string	是	更新时间

响应样例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "total": 0,
    "list": []
  }
}

固件管理 ​

固件上传 ​

固件详情 ​

固件列表查询（分页） ​

固件更新 ​

固件删除 ​

创建固件升级任务 ​

删除固件升级任务 ​

修改固件升级任务 ​

获取升级任务详情 ​

升级任务列表查询（分页） ​

升级日志详情 ​

升级日志分页查询 ​

创建升级策略 ​

删除升级策略 ​

修改升级策略 ​

升级策略详情 ​

升级策略列表分页查询 ​

固件管理

固件上传

固件详情

固件列表查询（分页）

固件更新

固件删除

创建固件升级任务

删除固件升级任务

修改固件升级任务

获取升级任务详情

升级任务列表查询（分页）

升级日志详情

升级日志分页查询

创建升级策略

删除升级策略

修改升级策略

升级策略详情

升级策略列表分页查询