文件
开启文件分享
1.接口说明
接口路径:/efile/openapi/v2/file/open-share
请求方式:POST
接口描述:开启文件分享
2.请求消息
请求参数:
Headers:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
token | string | 是 | token值 |
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
filePath | string | 是 | 文件的绝对路径 |
validDays | long | 否 | 有效天数,默认30天 |
3.请求示例
cURL请求示例
curl --location --request POST 'https://api01.xxx.com:65103/efile/openapi/v2/file/open-share?filePath=%2Fhome%2Ftest&validDays=30' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wdXRlVXNlciI6InNsdXJtdGVzdCIsImFjY291bnRTdGF0dXMiOiJPd2UiLCJjcmVhdG9yIjoiYWMiLCJlbmRwb2ludCI6IjAxIiwicm9sZSI6IjEiLCJleHBpcmVUaW1lIjoiMTY5OTE2NDYxNzAzMyIsImNsdXN0ZXJJZCI6IjExMjUwIiwiaW52b2tlciI6InNhY3AiLCJ1c2VyIjoic2x1cm10ZXN0IiwidXNlcklkIjoiMTI5MDcwMDk3MDEifQ.bxro-OYGjjpBDSD_lUiXzBdt6QggMniZDTnAm98O7ZQ' \
--header 'Content-Type: application/json'
Java请求示例
import okhttp3.*;
public class FileOpenShareDemo {
public static final String TOKEN = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wdXRlVXNlciI6InNsdXJtdGVzdCIsImFjY291bnRTdGF0dXMiOiJUcmlhbCIsImNyZWF0b3IiOiJhYyIsInJvbGUiOiIxIiwiZXhwaXJlVGltZSI6IjE2ODY5MDg1MDkyMzEiLCJjbHVzdGVySWQiOiIxMTExMiIsImludm9rZXIiOiI2MDQ4Y2U3YmExNWMyYWYyZThjZWMxMjk5MWVjMTNjZiIsInVzZXIiOiJzbHVybXRlc3QiLCJ1c2VySWQiOiIxMTY1NTA0ODU0MSJ9.U7pZKgO_K6NuRwOWPxblDfgRpGeVxS-BYieOdLhGDK4";
public static final String URL = "https://api01.xxx.com:65103/efile/openapi/v2/file/open-share?filePath=/home/test&validDays=30";
public static void main(String[] args) throws Exception {
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url(URL)
.method("POST", body)
.addHeader("token", TOKEN)
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}
Python请求示例
import requests
url = "https://api01.xxx.com:65103/efile/openapi/v2/file/open-share?filePath=/home/test&validDays=30"
payload = {}
headers = {
'Content-Type': 'application/json',
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wdXRlVXNlciI6InNsdXJtdGVzdCIsImFjY291bnRTdGF0dXMiOiJPd2UiLCJjcmVhdG9yIjoiYWMiLCJlbmRwb2ludCI6IjAxIiwicm9sZSI6IjEiLCJleHBpcmVUaW1lIjoiMTY5OTE2NDYxNzAzMyIsImNsdXN0ZXJJZCI6IjExMjUwIiwiaW52b2tlciI6InNhY3AiLCJ1c2VyIjoic2x1cm10ZXN0IiwidXNlcklkIjoiMTI5MDcwMDk3MDEifQ.bxro-OYGjjpBDSD_lUiXzBdt6QggMniZDTnAm98O7ZQ'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
4.响应消息
返回参数:
名称 | 类型 | 说明 |
---|---|---|
msg | string | 异常时的详细异常信息 |
code | string | 0:成功,10003:参数不完整,911020:文件不存在,911030:权限不足,911029:文件路径有非法字符,请重命名后操作,911025:分享文件已存在,请重命名后分享,911034:分享链接创建失败,请重新操作,10001:其它异常 |
data | object | |
serverCurlLink | string | 服务器curl链接 |
serverFastransLink | string | 服务器快传链接 |
webLink | string | 网页链接 |
validTime | string | 有效时间 |
返回示例:
{
"code": "0",
"data": {
"serverCurlLink":"curl -f -C - -o job_example.tar.gz https://api01.xxx.com:65103/efile/share/L3B1YmxpYy9ob21lL3l1bndlaTE5NA==/DKwDTXIv",
"serverFastransLink":"rayfile-c -a api01.xxx.com -P 65103 -u x -w 5306a83256L3B1YmxpYy9ob21lL3l1bndlaTE5NC8uc2hhcmVGaWxl_4c28d42d42f345b98b209d25262261b2 -o download -d <请输入下载目标文件夹全路径> -s /sql2.txt",
"webLink":"https://api01.xxx.com:65103/efile/share/am9iX2V4YW1wbGU=&(密码:Dsdb)",
"validTime":"30"
},
"msg": "success"
}
5.错误码
错误码 | 说明 |
---|---|
0 | 成功 |
10001 | 内部异常(其他异常) |
10003 | 参数不全 |
10004 | 参数无效 |
10009 | 不支持的版本 |
911009 | 区域用户不存在 |
911020 | 文件不存在 |
911021 | 文件已存在 |
911022 | 目标地址不是一个文件夹 |
911025 | 分享文件已存在,请重命名后分享 |
911029 | 文件路径包含特殊字符,请重命名后再操作 |
911030 | 权限不足,禁止操作 |
911031 | 文件重命名失败 |
911034 | 分享链接创建失败,请重新分享 |
911404 | ac认证服务端连接异常 |
911406 | 服务端token认证异常,未取到关联用户 |
911501 | 存储空间不足 |
911502 | 目录非空,操作失败 |
911504 | 命令执行超时 |
911505 | 文件大小超出预设大小,无法预览 |
911506 | 文件类型不在预设范围内,不允许打开 |
911507 | 源文件与目标文件一致,禁止操作 |
911700 | 文件名包含非法字符,请重命名后再操作 |