固件升级

大约 15 分钟

固件升级

OTA功能模块

创建OTA功能模块

POST	/admin-api/iot/ota-module/create

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	-	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	-	string
name	功能模块名称	json	true	string
alias	别名	json	false	string
description	描述	json	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品品类Id	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028976640,
  "msg": ""
}

获取OTA功能模块列表

GET	/admin-api/iot/ota-module/list

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	string
name	功能模块名称	json	false	string
alias	别名	json	false	string
description	描述，模糊查询	json	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	查询成功后返回数据列表	array
---id	产品分类id	long
---productId	productId	long
---productKey	productKey	string
---name	名称	string
---alias	别名	string
---description	描述	string
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
    "status": 0,
    "code": 0,
    "data": [
      {
        "productId": 1414626985410560,
        "productKey": "WSaSUV",
        "name": "test123",
        "alias": null,
        "description": null,
        "id": 1421126419865600,
        "createTime": 1734773462000
      },
      {
        "productId": null,
        "productKey": "WSaSUV",
        "name": "default",
        "alias": null,
        "description": null,
        "id": 1421120548814848,
        "createTime": 1734766295000
      },
      {
        "productId": null,
        "productKey": "kza2ib",
        "name": "default",
        "alias": null,
        "description": null,
        "id": 1379552761659392,
        "createTime": 1684024367000
      }
    ],
    "msg": ""
}

获取OTA功能模块分页

GET	/admin-api/iot/ota-module/page

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	页码，从 1 开始,示例值(1)	query	true	int32
pageSize	每页条数，最大值为 100,示例值(10)	query	true	int32
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	string
name	功能模块名称	json	false	string
alias	别名	json	false	string
description	描述，模糊查询	json	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品Id	object
---total	返回结果条数	int
---list	返回数据列表	array
------id	产品分类id	long
------productId	productId	long
------productKey	productKey	string
------name	名称	string
------alias	别名	string
------description	描述	string
------createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "list": [
      {
        "filesInfo": "[{\"fileSize\":757712,\"fileName\":\"wifi_pc_romote_start_module.bin\",\"fileUrl\":\"https://bucket-iot.oss-cn-guangzhou.aliyuncs.com/def3b02e3f3e40a2a5c246b8393df0dfa1d97efaa57287bae79e200f142f7057.bin\",\"fileMd5\":\"29451cb1cb28aad9e882e21b9255011e\",\"fileSign\":\"29451cb1cb28aad9e882e21b9255011e\"}]",
        "firmwareName": "eteef",
        "type": 0,
        "productId": 1414626985410560,
        "productKey": "WSaSUV",
        "moduleName": "default",
        "srcVersion": null,
        "destVersion": "1.0.0",
        "signMethod": "MD5",
        "sign": null,
        "needVerify": false,
        "description": null,
        "verifyProgress": "0",
        "packageUdi": null,
        "status": -1,
        "id": 1421120548823040,
        "createTime": 1734766295000
      }
    ],
    "total": 1
  },
  "msg": ""
}

获取OTA功能模块

GET	/admin-api/iot/ota-module/get

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	获取返回的对象	object
---id	产品分类id	long
---productId	productId	long
---productKey	productKey	string
---name	名称	string
---alias	别名	string
---description	描述	string
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "productId": 1414626985410560,
    "productKey": "WSaSUV",
    "name": "test123",
    "alias": null,
    "description": null,
    "id": 1421126419865600,
    "createTime": 1734773462000
  },
  "msg": ""
}

更新OTA功能模块

PUT	/admin-api/iot/ota-module/update

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要更新的品类id	json	true	long
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	string
name	功能模块名称	json	false	string
alias	别名	json	false	string
description	描述	json	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	更新成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

删除OTA功能模块

DELETE	/admin-api/iot/ota-module/delete

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要删除的id	json	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	删除成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

上传升级固件文件

POST	/admin-api/iot/product-update/upload

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
file	二进制文件流	json	true	long
path	文件路径,示例值(yudaoyuanma.png 、iot_bin)	json	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	上传成功返回结果	object
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "originalName": "wifi_pc_romote_start_module.bin",
    "size": 757712,
    "sign": "29451cb1cb28aad9e882e21b9255011e",
    "signMethod": "MD5",
    "downloadUrl": "https://bucket-iot.oss-cn-guangzhou.aliyuncs.com/def3b02e3f3e40a2a5c246b8393df0dfa1d97efaa57287bae79e200f142f7057.bin"
  },
  "msg": ""
}

OTA升级包

新建OTA升级包信息

POST	/admin-api/iot/ota-firmware/create

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
firmwareName	升级包名称	json	true	string
type	包类型，0：整包;1：差分	json	true	string
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	-	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	-	string
filesInfo	升级包文件信息，格式为JSON字符串	json	true	string
moduleName	模块名称	json	true	string
srcVersion	待升级版本（type = 1差分有效），差分包该参数必须，整包该参数非必须	json	true	string
destVersion	附件版本号	json	true	string
signMethod	签名	json	false	string
sign	签名值	json	false	string
needVerify	是否需要验收附件包；1：需要；0：不需要	json	false	string
packageUdi	额外信息	json	false	string
description	描述	json	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

filesInfo格式字符串示例

[
    {
        "fileSize": 757712,
        "fileName": "wifi_pc_romote_start_module.bin",
        "fileUrl": "https://bucket-iot.oss-cn-guangzhou.aliyuncs.com/def3b02e3f3e40a2a5c246b8393df0dfa1d97efaa57287bae79e200f142f7057.bin",
        "fileMd5": "29451cb1cb28aad9e882e21b9255011e",
        "fileSign": "29451cb1cb28aad9e882e21b9255011e"
    }
    ...
]

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品品类Id	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028976640,
  "msg": ""
}

获取OTA升级包信息

GET	/admin-api/iot/ota-firmware/get

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	获取返回的对象	object
---id	产品分类id	long
---productId	productId	long
---productKey	productKey	string
---firmwareName	升级包名称	string
---type	包类型，0：整包;1：差分	int
---filesInfo	升级包文件信息，格式为JSON字符串	string
---moduleName	模块名称	string
---srcVersion	待升级版本（type = 1差分有效）	string
---destVersion	附件版本号	string
---signMethod	签名	string
---sign	签名值	string
---needVerify	是否需要验收附件包；1：需要；0：不需要	string
---packageUdi	额外信息	string
---description	描述	string
---verifyProgress	验证进度	int
---status	固件状态；-1：不需要验证；0：未验证；1：验证中；2：已验证；3：验证失败；	int
---createTime	创建时间，时间戳13位	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "filesInfo": "[{\"fileSize\":757712,\"fileName\":\"wifi_pc_romote_start_module.bin\",\"fileUrl\":\"https://bucket-iot.oss-cn-guangzhou.aliyuncs.com/def3b02e3f3e40a2a5c246b8393df0dfa1d97efaa57287bae79e200f142f7057.bin\",\"fileMd5\":\"29451cb1cb28aad9e882e21b9255011e\",\"fileSign\":\"29451cb1cb28aad9e882e21b9255011e\"}]",
    "firmwareName": "eteef",
    "type": 0,
    "productId": 1414626985410560,
    "productKey": "WSaSUV",
    "moduleName": "default",
    "srcVersion": null,
    "destVersion": "1.0.0",
    "signMethod": "MD5",
    "sign": null,
    "needVerify": false,
    "description": null,
    "verifyProgress": "0",
    "packageUdi": null,
    "status": -1,
    "id": 1421120548823040,
    "createTime": 1734766295000
  },
  "msg": ""
}

获取OTA升级包信息列表

GET	/admin-api/iot/ota-firmware/list

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	string
firmwareName	固件名称,示例值(张三)	query	false	string
type	包类型，0：整包;1：差分,示例值(1)	query	false	string
moduleName	模块名称,示例值(default)	query	false	string
srcVersion	待升级版本（差分有效）	query	false	string
destVersion	附件版本号	query	false	string
needVerify	升级包是否需要平台验证	query	false	string
description	固件描述,示例值(你说的对)	query	false	string
packageUdi	额外信息	query	false	string
status	固件状态；-1：不需要验证；0：未验证；1：验证中；2：已验证；3：验证失败；	query	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品Id	object
---filesInfo	升级包文件	string
---firmwareName	升级包名称	string
---type	包类型，0：整包;1：差分	int
---productId	productId	long
---productKey	product_key	string
---moduleName	模块名称	string
---srcVersion	待升级版本（差分有效）	string
---destVersion	附件版本号	string
---signMethod	签名	string
---sign	签名值	string
---needVerify	升级包是否需要平台验证	boolean
---description	升级包描述	string
---verifyProgress	验证包验证进度	string
---packageUdi	额外信息	string
---status	固件状态；-1：不需要验证；0：未验证；1：验证中；2：已验证；3：验证失败；	int
---id	id	long
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data":[
      {
        "filesInfo": "[{\"fileSize\":757712,\"fileName\":\"wifi_pc_romote_start_module.bin\",\"fileUrl\":\"https://bucket-iot.oss-cn-guangzhou.aliyuncs.com/def3b02e3f3e40a2a5c246b8393df0dfa1d97efaa57287bae79e200f142f7057.bin\",\"fileMd5\":\"29451cb1cb28aad9e882e21b9255011e\",\"fileSign\":\"29451cb1cb28aad9e882e21b9255011e\"}]",
        "firmwareName": "eteef",
        "type": 0,
        "productId": 1414626985410560,
        "productKey": "WSaSUV",
        "moduleName": "default",
        "srcVersion": null,
        "destVersion": "1.0.0",
        "signMethod": "MD5",
        "sign": null,
        "needVerify": false,
        "description": null,
        "verifyProgress": "0",
        "packageUdi": null,
        "status": -1,
        "id": 1421120548823040,
        "createTime": 1734766295000
      }
    ],
  "msg": ""
}

获取OTA升级包信息分页

GET	/admin-api/iot/ota-firmware/list

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	页码，从 1 开始,示例值(1)	query	true	int32
pageSize	每页条数，最大值为 100,示例值(10)	query	true	int32
productId	查询指定产品ID的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	long
productKey	查询指定产品productKey的设备，productId和productKey只需要传一个就可以，也可以传两个	json	false	string
firmwareName	固件名称,示例值(张三)	query	false	string
type	包类型，0：整包;1：差分,示例值(1)	query	false	string
moduleName	模块名称,示例值(default)	query	false	string
srcVersion	待升级版本（差分有效）	query	false	string
destVersion	附件版本号	query	false	string
needVerify	升级包是否需要平台验证	query	false	string
description	固件描述,示例值(你说的对)	query	false	string
packageUdi	额外信息	query	false	string
status	固件状态；-1：不需要验证；0：未验证；1：验证中；2：已验证；3：验证失败；	query	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品Id	object
---total	返回结果条数	int
---list	返回数据列表	array
------filesInfo	升级包文件	string
------firmwareName	升级包名称	string
------type	包类型，0：整包;1：差分	int
------productId	productId	long
------productKey	product_key	string
------moduleName	模块名称	string
------srcVersion	待升级版本（差分有效）	string
------destVersion	附件版本号	string
------signMethod	签名	string
------sign	签名值	string
------needVerify	升级包是否需要平台验证	boolean
------description	升级包描述	string
------verifyProgress	验证包验证进度	string
------packageUdi	额外信息	string
------status	固件状态；-1：不需要验证；0：未验证；1：验证中；2：已验证；3：验证失败；	int
------id	id	long
------createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "list": [
      {
        "filesInfo": "[{\"fileSize\":757712,\"fileName\":\"wifi_pc_romote_start_module.bin\",\"fileUrl\":\"https://bucket-iot.oss-cn-guangzhou.aliyuncs.com/def3b02e3f3e40a2a5c246b8393df0dfa1d97efaa57287bae79e200f142f7057.bin\",\"fileMd5\":\"29451cb1cb28aad9e882e21b9255011e\",\"fileSign\":\"29451cb1cb28aad9e882e21b9255011e\"}]",
        "firmwareName": "eteef",
        "type": 0,
        "productId": 1414626985410560,
        "productKey": "WSaSUV",
        "moduleName": "default",
        "srcVersion": null,
        "destVersion": "1.0.0",
        "signMethod": "MD5",
        "sign": null,
        "needVerify": false,
        "description": null,
        "verifyProgress": "0",
        "packageUdi": null,
        "status": -1,
        "id": 1421120548823040,
        "createTime": 1734766295000
      }
    ],
    "total": 1
  },
  "msg": ""
}

删除OTA升级包信息

DELETE	/admin-api/iot/ota-firmware/delete

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要删除的id	json	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	删除成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

OTA升级批处理

新建OTA升级批处理

POST	/admin-api/iot/ota-batch-manage/create

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
batchType	批次类型，1：验证升级包；2：批量升级	query	true	string
upgradeType	升级类型，0：整包；1：差分包	query	true	string
firmwareId	关联固件ID	query	true	string
strategyType	升级策略，1：动态升级；2：静态升级	query	true	string
pushMode	是否云端主动推送升级，1：是；0：否	query	true	string
appConfirm	APP确认升级；1：需要；0：不需要	query	true	string
downloadProtocol	下载协议，目前只支持：HTTPS	query	true	string
deviceNames	选择目标设备deviceNames，可以多选，只有strategy=1定向升级时有效	query	false	array
areaIds	区域ID，可以多选，只有strategy=2区域升级时有效	query	false	array
groupId	分组ID，单选，选择设备分组id，只有strategy=4分组升级时有效	query	false	long
grayPercent	灰度升级百分比，只有strategy=3灰度升级时有效	query	false	string
srcVersion	待升级版本号，多选；strategyType=1动态升级该参数为必须项目，静态升级非必须	query	true	array
strategy	升级范围策略，0：全部设备；1：定向升级；2：区域升级；3：灰度升级；4：分组升级	query	false	string
upgradeTime	升级时间策略；1：立即升级；2：定时升级	query	false	string
fireTime	定时升级开始时间，当upgradeTime=2时，需要指定该值	query	false	string
scheduleFinishTime	定时升级结束时间，当upgradeTime=2时，需要指定该值	query	false	string
pushSpeedType	升级包推送类型，目前支持0：恒定速率升级	query	false	string
speedLimit	升级包推送速率	query	false	string
retryInterval	升级失败重试间隔，-1：不重试；0：立即重试；10：10分钟后重试，单位为：分钟	query	false	string
retryCount	失败重试次数，0：不重试；1：重试1次...	query	false	string
timeout	设备升级超时时间，单位：分钟，不填则不会超时	query	false	string
overwriteMode	是否覆盖设备之前的升级任务；1：是；0：否	query	false	string
tags	键值对信息，格式为JSON字符串	query	false	string
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

注意

动态升级：strategy只能选择全部设备、定向升级

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品品类Id	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028976640,
  "msg": ""
}