库操作

更新: 2017-10-19

API域名

Host: yk3-api-ent.gokuai.com

创建库

POST /1/org/create HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_name 库名称
org_logo 库logo url地址
org_capacity 库容量上限, 单位字节, 默认无上限
storage_point_name 库归属存储点名称, 默认使用够快存储
dateline 当前unix时间戳, 单位秒
sign 签名

返回格式

json

返回结果

{
    org_id:    
    mount_id:
}
字段 类型 说明
org_id int 库ID
mount_id int 库空间ID

修改库

POST /1/org/set HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库id
org_name 库名称, 不传表示不修改
org_logo 库logo url地址, 不传表示不修改
org_capacity 库容量上限, 单位字节, 不传表示不修改, 空字符串表示不设置上限
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


库信息

POST /1/org/info HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

{
    info:
    {
        org_id : 库ID
        org_name : 库名称
        org_desc : 库描述
        org_logo_url : 库图标url
        size_org_total : 库空间总大小, 单位字节, -1表示空间不限制
        size_org_use: 库已使用空间大小, 单位字节,
        file_count: 库文件数量, 不包括删除,
        dir_count: 库文件夹数量, 不包括删除,
        mount_id: 库空间id
    }
}

个人文件库信息

POST /1/org/info_by_member HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
member_id - 成员ID
out_id - 成员外部系统唯一ID
account - 成员外部系统登录帐号
dateline 当前unix时间戳, 单位秒
sign 签名

member_id, out_idaccount只需传其中一个

返回结果

{
    "info":
    {
        "org_id": 库ID
        "org_name": 库名称
        "org_desc": 库描述
        "org_logo_url": 库图标url
        "size_org_total": 库空间总大小, 单位字节, -1表示空间不限制
        "size_org_use": 库已使用空间大小, 单位字节,
        "file_count": 库文件数量, 不包括删除,
        "dir_count": 库文件夹数量, 不包括删除,
        "mount_id": 库空间ID
    }
}

注意: 如果个人文件库未初始化, 则只会返回管理员为个人文件库设置的空间大小size_org_total

{
    "info":
    {
        "size_org_total": 库空间总大小, 单位字节, -1表示空间不限制
    }
}

设置个人文件库

POST /1/org/set_by_member HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
member_id - 成员ID
out_id - 成员外部系统唯一ID
account - 成员外部系统登录帐号
capacity 库空间, 单位字节, -1表示空间不限制
dateline 当前unix时间戳, 单位秒
sign 签名

member_id, out_idaccount只需传其中一个

返回结果

HTTP 200


获取库列表

POST /1/org/ls HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
type 1返回非个人文件库, 2返回个人文件库, 默认0返回所有
member_id 只返回该成员参与的库
dateline 当前unix时间戳, 单位秒
sign 签名

返回格式

json

返回结果

{
'list':
    [
        {
            org_id : 库ID
            org_name : 库名称
            org_logo_url : 库图标url
            size_org_total : 库空间总大小, 单位字节, -1表示空间不限制
            size_org_use: 库已使用空间大小, 单位字节
            mount_id: 库空间id
        },
        ...
    ]
}

获取库授权

POST /1/org/bind HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id - 库ID, 库ID库空间ID必需传一个
mount_id - 库空间ID, 库ID库空间ID必需传一个
title 标题(预留参数)
url 链接(预留参数)
dateline 当前unix时间戳, 单位秒
sign 签名

返回格式

json

返回结果

{
    org_client_id:
    org_client_secret:
}
字段 类型 说明
org_client_id string 库授权client_id
org_client_secret string 库授权client_secret

org_client_secret用于调用 库文件操作 API签名时的密钥

注意: 每个client_id针对每个库只会生成1个授权, 再次调用时会返回前一次的授权


取消库授权

POST /1/org/unbind HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_client_id 库授权client_id
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


获取库成员列表

POST /1/org/get_members HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
start 分页开始位置,默认0
size 分页个数,默认20
dateline 当前unix时间戳, 单位秒
sign 签名

返回格式

json

返回结果

{
    list:
    [
        {
            "member_id": 成员id,
            "out_id": 成员外部id,
            "account": 外部账号,
            "member_name": 成员显示名,
            "member_email": 成员邮箱,
            "state": 成员状态。1:已接受,2:未接受,
        },
        ...
    ],
    count: 成员总数
}

查询库成员信息

POST /1/org/get_member HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库id
type ids的类型account, out_id, member_id
ids 多个用逗号,分隔 id1,id2,id3
dateline 当前unix时间戳, 单位秒
sign 签名

返回格式

json

返回结果

{
    "id(传入时的id))":{
        "member_id": 成员ID,
        "out_id": 成员外部系统唯一ID,
        "account": 成员外部登录帐号,
        "member_name": 成员显示名,
        "member_email": 成员邮箱
    },
    ...
}

添加库成员

POST /1/org/add_member HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
role_id 角色ID
member_ids 需要添加的成员ID, 多个用逗号,分隔
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


修改库成员角色

POST /1/org/set_member_role HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
role_id 角色ID
member_ids 需要修改的成员ID, 多个以逗号,分隔
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


删除库成员

POST /1/org/del_member HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
member_ids 成员id, 以逗号分隔
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


获取库的部门列表

POST /1/org/get_groups HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库id
dateline 当前unix时间戳, 单位秒
sign 签名

返回格式

json

返回结果

{
    {
        "id": 部门ID
        "name": 部门名称
        "role_id": 角色ID
    },
    ...
}

库上添加部门

POST /1/org/add_group HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
group_id 部门ID
role_id 角色ID
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


删除库上的部门

POST /1/org/del_group HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
group_id 部门ID
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


修改库上部门的角色

POST /1/org/set_group_role HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID
group_id 部门ID
role_id 角色ID
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


删除库

POST /1/org/destroy HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id - 库ID
org_client_id - 库授权, org_client_idorg_id 只需要传其中一个
dateline 当前unix时间戳, 单位秒
sign 签名

返回结果

HTTP 200


库日志

POST /1/org/log HTTP/1.1

请求参数

参数 必需 说明
client_id 企业授权管理中获得的client_id
org_id 库ID, 库ID库空间ID传了其中之一时, 只获取该库的操作日志
mount_id 库空间ID, 库ID库空间ID传了其中之一时, 只获取该库的操作日志
act 过滤操作, 不传默认返回所有操作, 多个操作用,分隔
start_dateline unix时间戳, 单位毫秒, 默认0, 获取操作时间 > start_dateline 的日志
size 获取日志条数, 默认100, 最多返回1000
dateline 当前unix时间戳, 单位秒
sign 签名
act操作 说明
0 删除
1 创建或上传
2 重命名
3 编辑
4 移动
5 删除被恢复
6 版本还原
12 锁定
13 解锁
20 下载
21 预览
1014 生成外链
1015 访问外链
1016 外链文件下载
1017 外链文件保存到云库
1018 外链文件上传

返回结果

最多只会返回1000条

HTTP 200

{
}