File接口

此接口调用时须在请求头中设置whaleal-Token ,填写参数发起请求,返回内容为 JSON 格式的信息,返回特殊实体类将在最后提供实体类表格。

请求头默认格式,特殊情况特殊声明

whaleal-Token在调用登录接口时返回,在之后调用接口时将token放置请求头中。

登录接口调用获取whaleal-Token

KEY VALUE
Accept-Encoding gzip,deflate,br
Connection keep-alive
Content-Type multipart/form-data; boundary=\
whaleal-token "token"


1 上传文件到Server端

1.1 请求路径

POST: http://{Server-Host}:{端口}/api/server/file/web/upload/file


1.2 请求参数

Name Located in Description Required Schema
File Body 上传的文件 Yes MultipartFile
whaleal-Token Params token Yes String


img_13.png


1.3 返回结果

Description Schema
code 状态符:1000成功,其余异常 int
msg 返回消息 String


img_33.png



2 删除server端文件

 此处请求头的Content-Type为application/json 

2.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/file/deleteFile/


2.2 请求参数

Name Located in Description Required Schema
filename Path 文件名称 Yes String


img_34.png


2.3 返回结果

Description Schema
code 状态符:1000成功,其余异常 int
msg 返回消息 String


img_35.png



3 获取server端的文件信息.

此处请求头的Content-Type为application/json 

3.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/file/getAllMongoFile


3.2 请求

img_36.png


3.3 返回结果

Description Schema
code 状态符:1000成功,其余异常 int
data 返回数据 JSON


{
    "code": 1000,
    "data": [
        {
            "createTime": 1658484806756,
            "updateTime": 1658484806756,
            "name": "mongodb-linux-x86_64-rhel70-4.2.17.tgz",
            "shortName": "mongodb-linux-x86_64-rhel70-4.2.17",
            "size": 133396543,
            "md5": "1",
            "version": null,
            "path": "/home/whaleal/server/mongodb-linux-x86_64-rhel70-4.2.17.tgz",
            "hostId": "",
            "server": true
        }
    ]
}


4 agent可以下载server端的文件

4.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/file/agent/download/


4.2 请求参数

Name Located in Description Required Schema
filename Path 文件名称 Yes String
agentId Header agentId Yes String


img_10.png


4.3 返回结果

Description Schema
文件 返回文件 File




5 更新server端的文件信息

此处请求头的Content-Type为application/json 

5.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/file/agent/updateAllMongoFileToAgent


5.2 请求


img_12.png


5.3 返回结果

Description Schema
code 状态符:1000成功,其余异常 int
msg 返回消息 String


img_13.png



6 下载巡检日志

6.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/file/download/mdiag///


6.2 请求参数

Name Located in Description Required Schema
clusterId Path 集群id Yes String
fileID Path 文件id Yes String
filename Path 文件名称 Yes String
whaleal-Token Params token Yes String


img_14.png


6.3 返回结果

Description Schema
mdiag 返回文件下载 File



7 下载mongo集群文件

7.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/file/download/mongoClusterFile//


7.2 请求参数

Name Located in Description Required Schema
clusterId Path 集群id Yes String
filename Path 文件名称 Yes String
fileIdList Params 文件id列表 Yes List
whaleal-Token Params token Yes String


img_5.png


7.3 返回结果

Description Schema
file 返回文件下载 File


8.1 请求路径

GET: http://{Server-Host}:{端口}/api/server/agent/downAgentFile//


8.2 请求参数

Name Located in Description Required Schema
agentId Path agentId Yes String
fileName Path 文件名称 Yes String


img_20.png


8.3 返回结果

Description Schema
File 二进制流形式返回文件 File


results matching ""

    No results matching ""