跳到主要内容

upload_forward_file_x 上传转发文件

POST /api/v1/clock_board/upload_forward_file_x

描述

基于当前的CGI文件上传接口设计,通过主控板向业务板转发文件上传请求时,需要分2步进行。

  1. 上传文件到主控板,主控板会缓存该文件
  2. 上传转发信息到主控板,主控板会根据转发信息,将缓存的文件转发给业务板

本接口是上传文件到主控板的接口,即上面描述的第一步。

访问权限

需要登录,具备以下权限:

clock_board:upload_forward_file_x

上传文件

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

采用文件上传的方式:

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

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

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

注意

只能包含一个上传文件,文件名会被忽略。 不能包含其他的参数。

响应结果

请求返回的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,
}

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

{
"success": false,
"errorCode": "40005",
"errorMessage": "not.file.upload.request",
"showType": 4
}

错误码

错误码说明错误信息显示类型
40005不是文件上传请求not.file.upload.request4
提示

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