库操作

更新: 2022-7-18

• 创建库
• 修改库
• 库信息
• 搜索库
• 个人文件库信息
• 设置个人文件库
• 获取库列表
• 获取库授权
• 取消库授权
• 获取库成员列表
• 查询库成员信息
• 设置库拥有者
• 添加库成员
• 修改库成员角色
• 删除库成员
• 获取库部门列表
• 库上添加部门
• 删除库上的部门
• 修改库上部门的角色
• 删除库
• 库日志

API域名

Host: yk3.gokuai.com

创建库

POST /m-open/1/org/create HTTP/1.1

请求参数

返回结果

{
    "org_id": 库ID,
    "mount_id": 库空间ID
}

修改库

POST /m-open/1/org/set HTTP/1.1

请求参数

返回结果

HTTP 200

库信息

POST /m-open/1/org/info HTTP/1.1

请求参数

返回结果

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

搜索库

POST /m-open/1/org/search HTTP/1.1

请求参数

返回结果

{
    "list":
    [
        {
            "org_id": 库ID,
            "org_name": "库名称",
            "org_logo_url": "库图标URL",
            "size_org_total": 库空间总大小, 单位字节, -1表示空间不限制
            "size_org_use": 库已使用空间大小, 单位字节
            "mount_id": 库空间ID,
            "owner_id": 库拥有者ID, 0表示未指定拥有者
        },
        ...
    ]
}

个人文件库信息

POST /m-open/1/org/info_by_member HTTP/1.1

请求参数

member_id, out_id, account和email只需传其中一个

返回结果

{
    "info":
    {
        "org_id": 库ID,
        "org_name": "库名称",
        "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 /m-open/1/org/set_by_member HTTP/1.1

请求参数

member_id, out_id, account和email只需传其中一个

返回结果

HTTP 200

获取库列表

POST /m-open/1/org/ls HTTP/1.1

请求参数

返回结果

{
    "list":
    [
        {
            "org_id": 库ID,
            "org_name": "库名称",
            "org_logo_url": "库图标URL",
            "size_org_total": 库空间总大小, 单位字节, -1表示空间不限制
            "size_org_use": 库已使用空间大小, 单位字节
            "mount_id": 库空间ID,
            "owner_id": 库拥有者ID, 0表示未指定拥有者
        },
        ...
    ]
}

获取库授权

POST /m-open/1/org/bind HTTP/1.1

请求参数

返回结果

{
    "org_client_id": "库授权client_id",
    "org_client_secret": "库授权client_secret"
}

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

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

取消库授权

POST /m-open/1/org/unbind HTTP/1.1

请求参数

返回结果

HTTP 200

获取库成员列表

POST /m-open/1/org/get_members HTTP/1.1

请求参数

返回结果

{
    "list":
    [
        {
            "member_id": 成员ID,
            "out_id": 成员外部ID,
            "account": "成员外部帐号",
            "member_name": "成员显示名",
            "member_email": "成员邮箱",
            "state": 成员状态,
            "role_id" 角色ID
        },
        ...
    ],
    count: 成员总数
}

查询库成员信息

POST /m-open/1/org/get_member HTTP/1.1

请求参数

返回结果

{
    "ids参数中的成员唯一ID或帐号":
    {
        "member_id": 成员ID,
        "out_id": "成员外部ID",
        "account": "成员外部帐号",
        "member_name": "成员显示名",
        "member_email": "成员邮箱",
        "state": 成员状态,
        "role_id": 角色ID
    },
    ...
}

设置库拥有者

POST /m-open/1/org/set_owner HTTP/1.1

请求参数

返回结果

HTTP 200

添加库成员

POST /m-open/1/org/add_member HTTP/1.1

请求参数

返回结果

HTTP 200

修改库成员角色

POST /m-open/1/org/set_member_role HTTP/1.1

请求参数

返回结果

HTTP 200

删除库成员

POST /m-open/1/org/del_member HTTP/1.1

请求参数

返回结果

HTTP 200

获取库部门列表

POST /m-open/1/org/get_groups HTTP/1.1

请求参数

返回结果

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

库上添加部门

POST /m-open/1/org/add_group HTTP/1.1

请求参数

返回结果

HTTP 200

删除库上的部门

POST /m-open/1/org/del_group HTTP/1.1

请求参数

返回结果

HTTP 200

修改库上部门的角色

POST /m-open/1/org/set_group_role HTTP/1.1

请求参数

返回结果

HTTP 200

删除库

POST /m-open/1/org/destroy HTTP/1.1

请求参数

返回结果

HTTP 200

库日志

POST /m-open/1/org/log HTTP/1.1

请求参数

返回结果

最多只会返回1000条

{
    "total": 总共匹配的日志条数,
    "list": [
        {
            "hash": "文件唯一ID",
            "dir": 0,
            "act": 1,
            "filehash": "文件内容hash",
            "filesize": 文件大小,
            "fullpath": "文件完整路径",
            "member_id": 操作人用户ID,
            "dateline": 操作时间, 单位秒,
            "act_name": "操作名称",
            "member_name": "操作人姓名(帐号)",
            "display_name": "操作人姓名",
            "member_account": "操作人帐号"
        },
        ...
    ]
}