文件
文本文件预览
1.接口说明
接口路径:/efile/openapi/v2/file/preview
请求方式:POST
请求数据类型:application/x-www-from-urlencoded
接口描述:文本文件预览
2.请求消息
请求参数:
Headers:
名称 | 类型 | 必填 | 描述 | 示例 |
---|---|---|---|---|
token | string | 是 | 接口凭证 | eyJhbGciOiJIUzI1N... |
参数:
名称 | 类型 | 必填 | 描述 | 示例 |
---|---|---|---|---|
path | string | 是 | 预览文件的绝对路径 | /public/home/test/sql2.txt |
force | string | 否 | 可选值:force:强制打开;default:默认方式 | default |
startIndex | long | 是 | 起始位置,默认值0 | 0 |
3.请求示例
cURL请求示例
curl --location 'https://api01.xxx.com:65103/efile/openapi/v2/file/preview' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wdXRlVXNlciI6InNsdXJtdGVzdCIsImFjY291bnRTdGF0dXMiOiJUcmlhbCIsImNyZWF0b3IiOiJhYyIsInJvbGUiOiIxIiwiZXhwaXJlVGltZSI6IjE2ODU2MDAyMjU2MTUiLCJjbHVzdGVySWQiOiIxMTExMiIsImludm9rZXIiOiI2MDQ4Y2U3YmExNWMyYWYyZThjZWMxMjk5MWVjMTNjZiIsInVzZXIiOiJzbHVybXRlc3QiLCJ1c2VySWQiOiIxMTY1NTA0ODU0MSJ9.iLCKJ8PnDDK0_SA2NPYm1WozUG8D5ojwFqFhwaJCDc8' \
--data-urlencode 'path=/public/home/test/BASE/Linux.pdf' \
--data-urlencode 'force=force' \
--data-urlencode 'startIndex=0'
Java请求示例
import okhttp3.*;
public class PreviewFileDemo {
public static final String TOKEN = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wdXRlVXNlciI6InNsdXJtdGVzdCIsImFjY291bnRTdGF0dXMiOiJUcmlhbCIsImNyZWF0b3IiOiJhYyIsInJvbGUiOiIxIiwiZXhwaXJlVGltZSI6IjE2ODY5MDg1MDkyMzEiLCJjbHVzdGVySWQiOiIxMTExMiIsImludm9rZXIiOiI2MDQ4Y2U3YmExNWMyYWYyZThjZWMxMjk5MWVjMTNjZiIsInVzZXIiOiJzbHVybXRlc3QiLCJ1c2VySWQiOiIxMTY1NTA0ODU0MSJ9.U7pZKgO_K6NuRwOWPxblDfgRpGeVxS-BYieOdLhGDK4";
public static final String URL = "https://api01.xxx.com:65103/efile/openapi/v2/file/preview";
public static void main(String[] args) throws Exception {
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "path=/public/home/test/BASE/Linux.pdf&force=force&startIndex=0");
Request request = new Request.Builder()
.url(URL)
.method("POST", body)
.addHeader("Content-Type", "application/x-www-form-urlencoded")
.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/preview"
payload = 'path=%2Fpublic%2Fhome%2Ftest%2FBASE%2FLinux.pdf&force=force&startIndex=0'
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wdXRlVXNlciI6InNsdXJtdGVzdCIsImFjY291bnRTdGF0dXMiOiJUcmlhbCIsImNyZWF0b3IiOiJhYyIsInJvbGUiOiIxIiwiZXhwaXJlVGltZSI6IjE2ODU2MDAyMjU2MTUiLCJjbHVzdGVySWQiOiIxMTExMiIsImludm9rZXIiOiI2MDQ4Y2U3YmExNWMyYWYyZThjZWMxMjk5MWVjMTNjZiIsInVzZXIiOiJzbHVybXRlc3QiLCJ1c2VySWQiOiIxMTY1NTA0ODU0MSJ9.iLCKJ8PnDDK0_SA2NPYm1WozUG8D5ojwFqFhwaJCDc8'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
4.响应消息
返回参数:
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
msg | string | 信息 | 操作成功 |
code | String | 状态码 | 0 |
data | Object | ||
content | object | 文本的内容 | |
endIndex | long | 当前页结束下标 | 731 |
hasNext | boolean | 是否还有下一页 | false |
path | string | 文件绝对路径 | /public/home/test/sql2.txt |
startIndex | long | 当前页起始下标 | 0 |
返回示例:
{
"code": "0",
"data": {
"path": "/public/home/test/sql2.txt",
"startIndex": "0",
"endIndex": 731,
"hasNext": false,
"content": "acctTime\r\nappType\r\ncommand\r\ncommandExist\r\ncpuNuclearHour\r\ncpuNuclearSec\r\ncpuUnitPrice\r\ndcuCardHour\r\ndcuCardSec\r\ndcuUnitPrice\r\ngpuCardHour\r\ngpuCardSec\r\ngpuUnitPrice\r\nefficiencyCpu\r\nexclusiveCputime\r\nexclusiveMem\r\nexclusiveWalltime\r\ngoldenable\r\ngroupName\r\nhistoryAccount\r\nhistoryQueuerate\r\nisSinglejob\r\njobCpuTime\r\njobDcuNum\r\njobEndTime\r\njobExecGpus\r\njobExecHost\r\njobExitStatus\r\njobGpuNum\r\njobId\r\njobMemUsed\r\njobName\r\njobProcNum\r\njobQueueTime\r\njobReqCpu\r\njobReqDcu\r\njobReqGpu\r\njobReqMem\r\njobReqNodes\r\njobResponseTime\r\njobStartTime\r\njobState\r\njobVmemUsed\r\njobWaitTime\r\njobWalltimeUsed\r\njobmanagerId\r\njobmanagerName\r\nneedNodes\r\nnodect\r\nowner\r\nqueue\r\nscale\r\nshareCputime\r\nshareMem\r\nshareWalltime\r\nstartCount\r\nuserName\r\nwalltime\r\nworkdir"
},
"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 | 文件名包含非法字符,请重命名后再操作 |