跳到主要内容

upgrade_status 升级状态

POST /api/v1/system/upgrade_status​

描述​

获取设备升级状态接口，用于获取设备升级状态。设备升级状态包括升级状态、升级进度等。

需要先调用 upgrade_firmware 接口上传固件文件，然后调用此接口获取升级状态。

升级固件过程中，调用此接口可以获取升级状态，包括升级状态、升级进度等。

如果升级成功，设备会等待6秒后自动重启。可以利用这个检查窗口，调用此接口获取升级完成的状态。

检查到升级完成后，可以提示用户系统正在重启。

访问权限​

需要登录，具备以下权限：

system:upgrade_status

JSON参数​

请求参数如下：

{}

无参数，必须传递空对象。

请求示例：

{}

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "data"?: {
    "status": "upgrading"|"complete"|"failed",
    "progress": 0~100
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

正确结果示例：

{
  "success": true,
  "data": {
    "status": "upgrading",
    "progress": 50
  }
}
:::warning
如果上传的配置文件成功后，设备会自动重新启动，重新启动后会应用新的配置文件。
:::

错误结果示例, 返回false时候需要带上错误码和错误信息：
```json
{
  "success": false,
  "errorCode": "40001",
  "errorMessage": "no.upgrading.firmware",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40000没有空白参数no.blank.params4
40001没有正在升级的固件no.upgrading.firmware4
提示

4 表示弹框提示错误信息。