# upload

#### 接口名称

Windows命令（CMD）：curl.exe -X POST "{BASE_URL}/upload?task_id={TASK_ID}" -H "{声明上传文件名}" -T "{待上传文件路径}"

Windows命令（PowerShell）：curl.exe -X POST "{BASE_URL}/upload?task_id={TASK_ID}" -H "{声明上传文件名}" -T "{待上传文件路径}"

Linux/MacOS命令：curl -X POST "{BASE_URL}/upload?task_id={TASK_ID}" -H "{声明上传文件名}" -T "{待上传文件路径}"


#### 接口描述

用于上传文件，通常以压缩包的形式上传，以便后续进行迁移等处理。


#### 参数说明

| 参数 | 参数说明 |
| --- | --- |
| task\_id | 可选参数，任务ID，用于唯一标识本次任务，绑定对应远程工作区。 若指定task\_id，则以指定的task\_id为准。 若指定的task\_id不存在，则会报错。 若未指定task\_id，系统会自动分配一个task\_id。 |


#### 使用示例

Windows命令（CMD）：

```
curl.exe -X POST "http://xxx.xxx.xxx.xxx:xxx/upload?task_id=20260728_084921_8cd5" -H "x-file-name: xxx.tar.gz" -T "/path/xxx.tar.gz"
```

Windows命令（PowerShell）：

```
curl.exe -X POST "http://xxx.xxx.xxx.xxx:xxx/upload?task_id=20260728_084921_8cd5" -H "x-file-name: xxx.tar.gz" -T "/path/xxx.tar.gz"
```

Linux/MacOS命令：

```
curl -X POST "http://xxx.xxx.xxx.xxx:xxx/upload?task_id=20260728_084921_8cd5" -H "x-file-name: xxx.tar.gz" -T "/path/xxx.tar.gz"
```

- task_id使用规则：

  - 
    若指定task_id，则以指定的task_id为准。

  - 
    若指定的task_id不存在，则会报错。

  - 
    若未指定task_id，系统会自动分配一个task_id。


- -H：curl命令参数，用于声明上传文件名（x-file-name），后端依此识别文件名称。
- -T：curl命令参数，用于指定本地要上传的压缩包文件，支持相对路径和绝对路径。
- 使用示例中BASE_URL、压缩包、task_id等参数请根据实际情况进行替换，BASE_URL为后端服务地址，格式为http://<IP地址>:<端口>。


#### 返回值

返回JSON格式的数据，包含状态码、提示信息、任务ID和项目路径，例如：

```
{
"code": 200,
"message": "文件上传成功！ ",
"task_id": "20260520_070249_7161",
"project_path": "cpptest"
}
```


**表1 参数说明**

| 参数 | 说明 |
| --- | --- |
| code | 状态码，表示请求的处理结果。 |
| message | 提示信息，描述操作结果的简短文本说明。 |
| task\_id | 任务ID，唯一标识本次上传或处理任务的ID，用于后续查询任务进度或状态。 |
| project\_path | 项目路径，文件上传后存储的项目目录路径。 |
