跳到主要内容

download_config 下载配置文件

POST /api/v1/system/download_config​

描述​

下载配置文件接口，用于下载设备的配置文件。配置文件是设备的配置信息，包括设备的基本信息、网络配置、系统配置等。 不同的设备配置文件内容不同，具体内容请参考设备的配置文件说明。

访问权限​

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

system:download_config

JSON参数​

请求参数如下：

{}

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

请求示例：

{}

响应结果​

响应结果中是导出的文件名称，可以使用http请求下载这个文件

{
  "success": boolean,
  "data"?:{
    "filename": string 
  },
  "errorCode"?: string,
  "errorMessage"?: string,
  "showType"?: number
}
提示

配置文件是一个tar.gz压缩文件，文件名为xxxconfig.tar.gz。配置文件内容是设备的配置信息，包括设备的基本信息、网络配置、系统配置等。不同的设备配置文件内容不同，具体内容请参考设备的配置文件说明。 不是专业人员不要随意修改配置文件，否则可能导致设备无法正常工作。请咨询设备厂商或者专业人员。

正确结果示例：

{
  "success": true,
  "data": {
    "filename": "/downloads/config.tar.gz"
  }
}

下载文件的请求示例：

const filename = data.filename;
const a = document.createElement('a');
a.href = filename;
const downloadFilename = filename.split('/').pop();
a.download = downloadFilename ? downloadFilename : 'config.tar.gz';
a.click();

错误结果示例, 返回false时候需要带上错误码和错误信息：

{
  "success": false,
  "errorCode"?: "40004",
  "errorMessage"?: "no.blank.params",
  "showType"?: 4
}

错误码​

错误码说明错误信息显示类型
40000没有空白参数no.blank.params4
提示

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