帮助中心 helper



获取项目的升级服务器升级任务API

发布于:2025-02-24 15:42 编辑:Surou  浏览:

如果客户想在自己程序里,获取升级服务器升级任务数据,则可以通过此片文章获取的API进行数据逻辑处理。

1.获取项目API

运行自己项目的NSetup打包环境,我们拿官方NSetup项目对应的打包环境进行演示

打开项目设置,找到项目升级地址,点击打开后面的帮助按钮

可以看到升级测试窗口

窗口上部显示的”发送的数据“即可当前项目的升级任务获取API,下面”接收的数据“即为通过API获取到的升级任务数据

2. 升级任务数据参数解释

发送:get请求

返回数据如下

{
    "ret": 200,
    "data": {
        "code": 0,
        "msg": "",
        "info": {
            "code": 0,
            "result": {
                "index": "20",
                "user_name": "admin",
                "project_id": "2",
                "currentVersion": "5.2.0.1",
                "lowestVersion": "5.2.0.1",
                "updateAddress": "https://nsetup-1252934363.cos.ap-chengdu.myqcloud.com/update/5.2.0.1",
                "spareUpdateAddress": "https://nsetup-1252934363.cos.ap-chengdu.myqcloud.com/update/5.2.0.1",
                "updateType": "0",
                "forcedType": "0",
                "checkType": "0",
                "updateInfo": "中文升级日志",
                "updateInfoEn": "英文升级日志",
                "updateTime": "1624614786",
                "taskStatus": "1",
                "remarks": ""
            },
            "msg": "getOneDataById success"
        }
    },
    "msg": ""
}

 

下面我们讲解下核心关心的部分参数

1. ret

为200,代表请求正常

2.project_id

项目id,与请求时设置的参数一致

3.currentVersion

当前版本

4.lowestVersion

最低版本

5.updateAddress

升级地址

6.spareUpdateAddress

备用地址

7.updateType

升级类型,0为普通升级,1为后台升级

8.forcedType

是否强制,0关闭强制,1开启强制

9.checkType

检测类型,0自动升级,1手动升级

10.updateInfo

中文升级信息

11.updateInfoEn

英文升级信息

12.updateTime

升级任务更新时间戳

13.taskStatus

任务状态,0无效,1有效

14.remarks

备注,可用于特殊需求的数据存取

 

各参数与升级后端设置对应,详细功能解释可参考《NSetup升级系统后端升级任务参数介绍