悦库开发者手册 V4.2.5

 

服务端API

仓库

创建仓库

请求语法

Header参数

Body数据

body数据采用JSON格式

字段类型必需说明
namestringtrue仓库名
typestringtrue仓库类型(“private”,“cooperative”,“public”)
aclarrayfalse访问控制列表

acl数组中,每个元素的数据格式

字段类型说明
orgTypestring类型
部门:“dept”
用户:“user”
orgIdnumber用户ID或部门ID
permissionIdnumber权限ID

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanumber新创建的仓库ID

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

删除仓库

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-Passwordstringtrue用户密码,URL编码

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
WrongPassword401密码错误。
PermissionDenied403无权执行此操作。
StoreNotExist404仓库不存在。

示例

请求示例

返回示例

 

获取仓库

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray仓库信息

应答JSON数据中,data字段的格式

字段类型说明
idnumber仓库ID
namestring仓库名
typestring仓库类型
私有:“private”
协同:“cooperative”
公共:“public”
sizenumber大小字节数
usednumber已使用空间字节数
fileNumnumber文件数量
dirNumnumber文件夹数量
managernumber仓库管理者ID
managerNamestring仓库管理者名字
deptNamestring所属部门名称(type值为“cooperative”时,有效)
createdTimenumber创建时间,UNIX时间戳
modifiedTimenumber修改时间,UNIX时间戳

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
StoreNotExist404仓库不存在。

示例

请求示例

返回示例

 

获取仓库列表

根据用户的权限获取当前用户可以访问的仓库列表。

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-Typestringfalse仓库类型
私有:“private”
协同:“cooperative”
公共:“public”
X-YFS-SortFieldstringfalse排序字段
名称:“name”
修改时间:“modifiedTime”
已使用大小:“used”
X-YFS-SortOrderstringfalse排序次序
升序:“asc”
降序:“desc”

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray仓库列表

data数组中每个仓库信息的数据格式

字段类型说明
idnumber仓库ID
namestring仓库名
typestring仓库类型(“private”、“cooperative”、“public”)
sizenumber大小字节数
usednumber已使用空间字节数
fileNumnumber文件数量
dirNumnumber文件夹数量
managernumber仓库管理者ID
managerNamestring仓库管理者名字(type值为“cooperative”和“public”时,有效)
deptNamestring所属部门名称(type值为“cooperative”时,有效)
createdTimenumber创建时间,UNIX时间戳
modifiedTimenumber修改时间,UNIX时间戳

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
TaskNotExist404任务不存在。

示例

请求示例

返回示例

 

更新仓库

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID

Body数据

body数据采用JSON格式

字段类型必需说明
namestringfalse仓库名
typestringfalse仓库类型
私有:“private”
协同:“cooperative”
公共:“public”
managernumberfalse仓库管理者的用户ID

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataobject

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
StoreNotExist404仓库不存在。

示例

请求示例

返回示例

 

获取可见的仓库视图

请求语法

Header参数

Body数据

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray仓库类型列表
个人:“private”
协同:“cooperative”
公共:“public”

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
UserNotExist404用户不存在。

示例

请求示例

返回示例

 

文件

获取文件(夹)信息

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdstringtrue文件所在仓库ID
X-YFS-FileIdstringtrue文件ID

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray文件信息

应答JSON数据中,data字段的格式

字段类型描述
idstring文件ID
parentIdstring所属目录ID
storeIdnumber所属仓库ID
pathIdnumber路径ID(文件为:0)
pathstring节点路径
gradenumber所属层级
namestring名称
typenumber类型(文件夹:0,文件:1)
sizenumber大小字节数
createdBynumber创建者ID
accessedBynumber访问者ID
editedBynumber内容修改者ID
modifiedBynumber信息修改者ID
createdTimenumber创建时间(UNIX时间戳)
accessedTimenumber访问时间(UNIX时间戳)
editedTimenumber内容修改时间(UNIX时间戳)
modifiedTimenumber信息修改时间(UNIX时间戳)
clientIdstring客户端ID
snnumber序号
clusterstring块蔟
offsetnumber首块偏移
statenumber文件状态(待定)

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
FileStoreNotExist404文件仓库不存在:ID。
FileNotExist404文件不存在:ID。
PermissionDenied403权限不够,操作被拒绝。

示例

请求示例

返回示例

 

获取目录下的文件列表

获取目录下有权访问的的文件列表

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdstringtrue仓库ID
X-YFS-DirIdstringtrue文件夹ID
X-YFS-SortFieldstringfalse排序字段
名称:”name“
类型:”type“
修改时间:”editedTime“
大小:”size“
X-YFS-SortOrderstringfalse排序次序
升序:”asc“
降序:”desc“

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray文件信息列表

应答JSON数据中,data字段的格式

字段类型描述
idstring文件ID
parentIdstring所属目录ID
storeIdnumber所属仓库ID
pathIdnumber路径ID(文件为:0)
pathstring节点路径
gradenumber所属层级
namestring名称
typenumber类型(文件夹:0,文件:1)
sizenumber大小字节数
createdBynumber创建者ID
accessedBynumber访问者ID
editedBynumber内容修改者ID
modifiedBynumber信息修改者ID
createdTimenumber创建时间(UNIX时间戳)
accessedTimenumber访问时间(UNIX时间戳)
editedTimenumber内容修改时间(UNIX时间戳)
modifiedTimenumber信息修改时间(UNIX时间戳)
clientIdstring客户端ID
snnumber序号
clusterstring块蔟
offsetnumber首块偏移
statenumber文件状态

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
FIleStoreNotExist404文件仓库不存在:ID。
PermissionDenied403权限不够,操作被拒绝。

示例

请求示例

返回示例

 

根据关键字搜索文件列表

获取从仓库(StoreId)、文件夹(DirId)下根据关键字(Key)搜索名字中包含关键字(Key)的文件列表。

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue仓库ID
X-YFS-DirIdstringtrue文件夹ID
X-YFS-SearchKeystring(URL编码)true搜索关键字
X-YFS-SortFieldstringfalse排序字段
X-YFS-SortOrderstringfalse排序次序(升序:“ASC”,降序:“DESC”)

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray文件信息列表

应答JSON数据中,data数组中元素的格式

字段类型描述
idstring文件ID
parentIdstring所属目录ID
storeIdnumber所属仓库ID
pathIdnumber路径ID(文件为:0)
pathstring节点路径
gradenumber所属层级
namestring名称
typenumber类型(文件夹:0,文件:1)
sizenumber大小字节数
createdBynumber创建者ID
accessedBynumber访问者ID
editedBynumber内容修改者ID
modifiedBynumber信息修改者ID
createdTimenumber创建时间(UNIX时间戳)
accessedTimenumber访问时间(UNIX时间戳)
editedTimenumber内容修改时间(UNIX时间戳)
modifiedTimenumber信息修改时间(UNIX时间戳)
clientIdstring客户端ID
snnumber序号
clusterstring块蔟
offsetnumber首块偏移
statenumber文件状态

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
FIleStoreNotExist404文件仓库不存在:ID。
PermissionDenied403权限不够,操作被拒绝。

示例

请求示例

返回示例

 

重命名文件

重命名文件或文件夹

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdstringtrue文件所在仓库ID
X-YFS-FileIdstringtrue文件ID
X-YFS-Namestring(URL编码)true新文件名称

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
FileStoreNotExist404文件仓库不存在。
FileNotExist404文件不存在。
InvalidFileName400无效文件名。
FileNameRepeat409文件名重复。
PermissionDenied403权限不够,操作被拒绝。

示例

请求示例

返回示例

 

获取文件(夹)的绝对路径

根据文件ID,获取其在系统中的绝对路径

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件(夹)ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datastring绝对路径字符串

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
StoreNotExist404仓库不存在。
FileNotExist404文件不存在。

示例

请求示例

返回示例

 

删除文件至回收站

将文件移动到回收站

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdstringtrue文件所在仓库ID
X-YFS-DelAllSubFilesstringfalse如果是文件夹,是否删除其下所有子文件。 删除:“true”、不删除:“false”;默认为“true”

Body数据

body数据采用JSON格式为:要删除文件的ID列表

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404文件仓库不存在。
PermissionDenied403权限不够,操作被拒绝。

示例

请求示例

返回示例

 

彻底删除文件

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdstringtrue文件所在仓库ID
X-YFS-DelAllSubFilesstringfalse如果是文件夹,是否删除其下所有子文件。 删除:“true”、不删除:“false”;默认为“true”

Body数据

body数据采用JSON格式为:要删除文件的ID列表

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400XXX 参数无效。
FileStoreNotExist404文件仓库不存在。
PermissionDenied403权限不够,操作被拒绝。
DatabaseDeleteFailed500数据库执行删除结果不符合预期。

示例

请求示例

返回示例

 

获取回收站文件列表

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-SortFieldstringfasle排序字段
文件名称:”name“
文件大小:”size“
删除时间:”deletedTime“
X-YFS-SortOrderstringfalse排序顺序
升序:“asc”
降序:”desc“

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray文件信息

应答JSON数据中,data字段的格式

字段类型描述
idstring文件ID
parentIdstring文件父ID
storeIdstring文件所属仓库ID
pathstring文件节点路径
namestring文件名
typenumber文件类型(文件夹:0,文件:1)
sizenumber文件大小字节数
createdBynumber文件创建者ID
accessedBynumber文件访问者ID
editedBynumber文件内容修改者ID
modifiedBynumber文件元信息修改者ID
createdTimenumber文件创建时间(UNIX时间戳)
accessedTimenumber文件访问时间(UNIX时间戳)
editedTimenumber文件内容修改时间(UNIX时间戳)
modifiedTimenumber文件元信息修改时间(UNIX时间戳)
clusterstring文件对象
offsetnumber文件偏移(文件块中的偏移值)
statenumber文件状态(锁定:1,外链:2)

错误码

错误码HTTP 状态码描述
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。

示例

请求示例

返回示例

 

文件下载

下载空间中的文件

支持文件和文件夹下载,文件夹会打包成ZIP格式下载,必须拥有下载权限

请求语法

参数说明

参数名参数类型必需说明
storeIdnumbertrue仓库ID
fileIdstringtrue文件ID
tokenstringtrueJWT认证令牌
namestringfalse下载的文件名称,URL编码

示例

下载文件历史版本

请求语法

参数说明

参数名参数类型必需说明
storeIdnumbertrue仓库ID
fileIdstringtrue文件ID
versionnumbertrue文件版本号(为“0”表示下载最新文件)
tokenstringtrueJWT认证令牌

示例

下载回收站文件

请求语法

参数说明

参数名参数类型必需说明
storeIdnumbertrue仓库ID
fileIdstringtrue文件ID
tokenstringtrueJWT认证令牌

示例

 

 

文件锁

锁定文件

拥有文件编辑权限的用户,可以使用独占锁锁定文件,锁定之后,除锁定者外其他人不能修改文件。

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
Unsupported405文件夹不支持此操作
PermissionDenied403权限被拒绝
FileIsLocked409文件已被锁定

示例

请求示例

返回示例

 

解锁文件

只有锁定者和拥有仓库管理权限的用户能够解锁。

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
Unsupported405文件夹不支持此操作
PermissionDenied403权限被拒绝

示例

请求示例

返回示例

 

获取文件锁信息

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataobject文件锁信息

data数据格式

字段类型描述
storeIdnumber仓库ID
fileIdstring文件ID
typestring文件锁类型:
独占锁:“exclusive”
共享锁:“shared”
lockedBynumber锁定用户ID
lockedUsernamestring锁定用户名
lockedTimenumber锁定时间UNIX时间戳

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
FileIsNotLocked404文件没有被锁定
PermissionDenied403权限被拒绝

示例

请求示例

返回示例

 

历史版本

获取文件历史版本列表

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray历史版本列表

data数组元素的数据格式

字段类型描述
versionnumber版本号(为”0”时,表示最新版本)
storeIdnumber仓库ID
fileIdstring文件ID
namestring文件名
sizenumber文件大小字节数
clusterstring文件块蔟
offsetnumber首个数据块的偏移字节数
editedTimenumber修改时间,UNIX时间戳
editedBynumber修改者ID
editedUsernamestring修改者用户名

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
PermissionDenied403权限被拒绝

示例

请求示例

返回示例

 

获取文件历史版本信息

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件ID
X-YFS-Versionnumberfalse版本号(为“0”或忽略表示最新版本)

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataobject文件版本信息

data的数据格式

字段类型描述
versionnumber版本号(为”0”时,表示最新版本)
storeIdnumber仓库ID
fileIdstring文件ID
namestring文件名
sizenumber文件大小字节数
clusterstring文件块蔟
offsetnumber首个数据块的偏移字节数
editedTimenumber修改时间,UNIX时间戳
editedBynumber修改者ID

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
VersionNotExist404版本不存在
PermissionDenied403权限被拒绝

示例

请求示例

返回示例

 

删除文件历史版本

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue仓库ID
X-YFS-FileIdstringtrue文件ID
X-YFS-Versionnumbertrue版本号

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
VersionNotExist404版本不存在
PermissionDenied403权限被拒绝

示例

请求示例

返回示例

 

恢复指定历史版本

把文件恢复至指定的历史版本

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue仓库ID
X-YFS-FileIdstringtrue文件ID
X-YFS-Versionnumbertrue版本号

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
StoreNotExist404仓库不存在
FileNotExist404文件不存在
VersionNotExist404版本不存在
PermissionDenied403权限被拒绝

示例

请求示例

返回示例

 

权限

获取权限列表

获取权限列表

请求语法

Header参数

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray

应答JSON数据中,data数组的每个元素的格式

字段类型说明
idnumber权限ID
namestring权限名称
descstring权限描述

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

获取文件的访问控制记录

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-StoreIdnumbertrue文件所属仓库ID
X-YFS-FileIdstringtrue文件(夹)ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray

应答JSON数据中,data数组的每个元素的格式

字段类型说明
idnumber访问控制记录ID
orgIdnumber部门ID或用户ID
orgNamestring部门名称或用户名
permissionIdnumber权限ID
permissionNamestring权限名称

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
StoreNotExist404仓库不存在。
FileNotExist404文件不存在。

示例

请求示例

返回示例

 

删除访问控制记录

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-RecordIdnumbertrue访问控制记录ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
RecordNotExist404记录不存在。

示例

请求示例

返回示例

 

添加访问控制记录

请求语法

Header参数

Body数据

body数据采用JSON格式

字段类型说明
orgTypestring组织类型:用户“user”,部门“dept”
orgIdnumber部门ID或用户ID
storeIdnumber文件(夹)所属仓库ID
fileIdstring文件(夹)ID
permissionIdnumber权限ID

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray

应答JSON数据中,data字段的格式

字段类型说明
idnumber新添加的访问控制记录ID
orgTypestring组织类型:用户“user”,部门“dept”
orgIdnumber用户ID或部门ID
userNamestring用户名(如果此纪录是为部门设置的,则值为空字符串)
deptNamestring部门名称
storeIdnumber仓库ID
storeNamestring仓库名称
fileIdstring文件ID
fileNamestring文件名
permissionIdnumber权限ID
permissionNamestring权限名称

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
PermissionNotExist404权限不存在。
OrgNotExist404部门或用户不存在。
StoreNotExist404仓库不存在。
FileNotExist404文件资源不存在。
AccessControlExist409访问控制配置已存在。

示例

请求示例

返回示例

 

修改访问控制记录

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-RecordIdnumbertrue访问控制记录ID

Body数据

body数据采用JSON格式

字段类型说明
orgTypestring组织类型:用户为“user”,部门为“dept”
orgtIdnumber部门ID/用户ID
storeIdnumber文件(夹)所属仓库ID
fileIdstring文件(夹)ID
permissionIdnumber权限ID

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray

应答JSON数据中,data字段的格式

字段类型说明
idnumber访问控制记录ID

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。
PermissionNotExist404权限不存在。
OrgNotExist404部门或用户不存在。
StoreNotExist404仓库不存在。
FileNotExist404文件资源不存在。

示例

请求示例

返回示例

 

组织

用户登录

使用账号和密码登录网盘系统

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-Accountstring(URL编码)true账号
X-YFS-Passwordstring(URL编码)true密码
X-YFS-ClientIdstringfalse客户端ID

Body数据

应答数据

应答数据格式(JSON)

字段类型描述
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarray登录成功时,包含JWT令牌,用户信息,服务器地址等

应答JSON数据中,data字段的格式

字段类型描述
tokenstringJWT令牌
userInfoarray用户信息
serverUrlarray服务器信息

userInfo字段格式

字段类型描述
idnumber用户ID
deptnumber部门ID
accountstring账号
namestring姓名
typestring类型:“admin”超级管理员,“common”普通用户
rolenumber角色
quotanumber私有空间大小限制字节数【为0时,表示不限制空间】

serverUrl字段格式

字段类型描述
internalarray内网访问地址信息
externalarray外网访问地址信息

external和internal字段格式

字段类型描述
apistringapi服务地址
webstringweb服务地址
ossstringoss服务地址

错误码

错误码HTTP 状态码描述
AccountNotExist400账号不存在:account。
WrongPassword400密码错误。
ExceedLicenseLimit403超出了授权数限制。
UserNotExist404用户不存在:account。
VersionNotMatched403版本不匹配

错误码对应的附加数据

VersionNotMatched

字段类型描述
versionstring服务端版本号,如:1.0.2.2
downloadUrlstring与服务端版本匹配的客户端下载地址

示例

请求示例

返回示例

 

获取部门下的子部门和用户列表

获取指定部门的子部门和用户列表

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-DeptIdnumbertrue部门ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataobject

data的数据格式为数组,每个元素的数据格式如下

字段类型说明
idnumber部门ID或用户ID。
parentIdnumber所属部门ID。
namestring部门名称或用户名。
typestring部门为“dept”,用户为“user”。

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
InvalidArgument400参数无效。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

Token

创建APIToken

只有系统管理员才能访问此API接口

请求语法

Header参数

Body数据

字段VALUE类型必需说明
namestringtrueToken名称

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataobjectToken信息

Token信息的格式

字段类型说明
idnumberToken ID
namestringToken名称
tokenstringToken字符串
createdTimenumber创建时间,UNIX时间戳
accessedTimenumber访问时间,UNIX时间戳

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

创建用户Token

只有系统管理员才能访问此API接口

请求语法

Header参数

Body数据

字段VALUE类型必需说明
accountstringtrue账号
usernamestringtrue用户名

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datastingToken字符串

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

获取APIToken列表

只有系统管理员才能访问此API接口

请求语法

Header参数

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
dataarrayToken信息数组

Token信息的格式

字段类型说明
idnumberToken ID
namestringToken名称
tokenstringToken字符串
createdTimenumber创建时间,UNIX时间戳
accessedTimenumber访问时间,UNIX时间戳

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

删除Token

只有系统管理员才能访问此API接口

请求语法

Header参数

KEYVALUE类型必需说明
X-YFS-TokenIdnumbertruetoken ID

Body数据

应答数据

应答数据格式(JSON)

字段类型说明
codestring状态码(“OK”表示成功)
messagestring消息(code不为“OK”时,返回错误消息)
datanull

错误码

错误码HTTP 状态码说明
InvalidAuthorization401无效授权码。
ExpiredAuthorization401授权码已过期。
PermissionDenied403无权执行此操作。

示例

请求示例

返回示例

 

客户端后台服务API

客户端后台服务运行于客户端电脑后台,默认监听4170端口,可以使用API与其进行交互。

 

询问客户端服务的身份信息

确认是否是客户端服务

请求语法

Header参数

示例

请求示例

返回示例

 

登录

接口用于客户端用户登录

请求语法

Header参数

示例

请求示例

返回示例

 

错误码

错误码HTTP 状态码描述
AccountNotExist400账号不存在:account。
WrongPassword400密码错误。
NotFoundUser404用户不存在:account。
NotFoundAffiliation404不能确定用户的从属关系:account。

 

获取未挂载的盘符

获取windows系统中未被挂载的盘符,支持win7及以上系统。

请求语法

Header参数

示例

请求示例

返回示例

错误码

成功

文件

创建下载任务

创建文件/文件夹下载任务,每一个任务只对应一个文件或文件夹。

请求语法

Header参数

示例

请求示例

返回示例

错误码

 

创建上传任务

创建文件/文件夹上传任务,每一个任务只对应一个文件或文件夹。

请求语法

Header参数

示例

请求示例

应答示例

错误码

错误码描述附加 JSON
FileNotExist文件不存在。
FileOccupied文件已经被其他进程占用。{
"fileName":"test.docx",
"fileLocalPath":"E:\ydisk\client\xx\docs"
}

 

取消传输任务

取消正在传输的上传或下载任务

请求语法

Header参数

示例

请求示例

应答示例

错误码

判断文件是否已本地缓存

判断文件是否已本地缓存

请求语法

Header参数

示例

请求示例

应答示例

错误码

存在

不存在

打开缓存位置

打开文件对应的本地缓存位置

请求语法

Header参数

示例

请求示例

应答示例

错误码

存在

不存在

打开虚拟盘位置

打开文件对应的虚拟盘位置

请求语法

Header参数

示例

请求示例

应答示例

错误码

存在

不存在

通知消息

客户端后台服务通知消息到前端。

 

通知错误

用于通知错误信息到客户端前端

消息ID

消息体字段描述

该通知包含以下字段:

消息体示例

 

通知下载任务进度

用于通知下载任务状态到客户端前端

消息ID

消息体字段描述

该通知data字段包含以下字段:

消息体示例

 

通知上传任务进度

用于通知上传任务状态到客户端前端

消息ID

消息体字段描述

该通知data字段包含以下字段:

消息体示例

 

通知文件锁定

用于通知文件锁定状态到客户端前端

消息ID

消息体字段描述

该通知data字段包含以下字段:

 

通知文件解锁

用于通知文件解锁状态到客户端前端

消息ID

消息体字段描述

该通知data字段包含以下字段:

 

通知虚拟盘挂载的结果

用于通知虚拟盘挂载的结果

消息ID

消息体字段描述

 

单点登录对接方案

实现甲方系统登录到悦库网盘

悦库可以轻松实现与甲方系统(第三方系统)的用户集成,当甲方用户登录服务端后可以获取该用户的悦库网盘地址。

实现步骤:

  1. 使用超级管理员账号登录悦库服务端,获取api token,供甲方服务端使用。
  2. 当甲方客户端用户登录时,在甲方服务端上使用api token向悦库服务端请求该用户的私有token。
  3. 甲方服务端根据悦库用户私有token生成访问地址,并返回给客户端。
  4. 客户端使用悦库URL访问网盘。

登录流程如下:

image-20210805140909364