跳到主要内容

quick_config_upload 快速配置

POST /api/v1/system/quick_config_upload​

描述​

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

上传过程将忽略网络配置文件。

访问权限​

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

system:quick_upload_config

上传配置文件​

使用multipart/form-data格式上传文件。

采用文件上传的方式：

POST /api/v1/system/upload_config HTTP/1.1
Host: <ip>:<port>
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-length: 12345

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="config.tar.gz"
Content-Type: application/octet-stream
file content, binary data, not shown here
------WebKitFormBoundary7MA4YWxkTrZu0gW--
提示

可以使用上传控件上传文件，也可以使用curl命令上传文件。 文件上传标准参考rfc1867

注意

只能包含一个上传文件，文件名会被忽略，文件内容会被解析为License文件。 不能包含其他的参数。

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

正确结果示例：

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

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

错误码​

错误码说明错误信息显示类型
40005上传配置文件格式错误config.file.format.error4
40006上传配置文件设备不支持config.file.device.not.support4
提示

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