华为云用户手册

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink shareLink object 分享链接信息 表6 shareLink 参数 参数类型 描述 shareId String 分享id shortUrl String 分享链接 extractCode String 提取码 createTime String 创建时间 updateTime String 修改时间 expireTime String 失效时间

请求示例 PUT /koodrive/ose/v1/share/{shareId} { "deptIds" : [ "string" ], "groupIds" : [ "string" ], "userIds" : [ "string" ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:00:39.952Z", "extractCode" : "string", "comment" : "string", "validDays" : 0 }

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "extractCode" : "string", "createTime" : "2024-06-03T02:00:39.953Z", "updateTime" : "2024-06-03T02:00:39.953Z", "expireTime" : "2024-06-03T02:00:39.953Z" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表3 请求Body参数 参数 是否必选 参数类型 描述 deptIds 否 Array of strings 部门id列表 groupIds 否 Array of strings 用户组id列表 userIds 否 Array of strings 用户id列表 permission 否 SharePermission object 分享权限（后续支持） expireTime 否 String 失效时间 extractCode 否 String 提取码 comment 否 String 分享留言 validDays 是 Integer 分享有效天数0-365. 0表示不变 表4 SharePermission 参数 是否必选 参数类型 描述 preview 否 Boolean 预览权限 edit 否 Boolean 编辑权限 download 否 Boolean 下载权限

请求示例 POST /koodrive/ose/v1/share/tasks { "taskType" : 0, "containerId" : "string", "fileIds" : [ "string" ], "targetFileId" : { "fileId" : "string", "containerId" : "string" }, "zipName" : "string", "shareId" : "string", "kdstoken" : "string" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表2 请求Body参数 参数 是否必选 参数类型 描述 taskType 是 Integer 批量操作任务类型；1：下载，2：转存 containerId 是 String 文件所在空间 fileIds 是 Array of strings 文件id列表 targetFileId 否 FileIdInfo object 文件id信息 zipName 否 String 压缩包名称，与文件管理的打包下载一致 shareId 是 String 分享id kdstoken 否 String 分享临时token 表3 FileIdInfo 参数 是否必选 参数类型 描述 fileId 是 String 文件id containerId 是 String 空间id

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表2 请求Body参数 参数 是否必选 参数类型 描述 shareId 是 String 分享ID fileId 是 String 文件ID kdstoken 是 String 分享临时token

API概览 云空间服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 批量任务操作 包括创建批量任务、取消批量任务、查询批量操作任务列表等批量任务接口。 部门管理 包括创建、修改、删除、查询部门等部门管理接口。 用户管理 包括新建、修改、删除、查询用户等用户管理接口。 空间管理 包括创建、修改、删除、查询空间等空间管理接口。 群组管理 包括创建用户群组、删除群组等接口。 会话管理 包括初始化创建会话、更新会话、登录登出等会话管理接口。 服务订阅 提供业务控制服务获取管理控制服务的订阅状态的接口。 企业设置 提供设置打包下载时生成的压缩包过期清理时间的接口。 云解压 提供列举压缩包目录的接口。 获取文件列表 提供获取个人空间文件列表和群组部门空间文件列表的接口。 文件管理 包括获取文件的详细信息、新增文件目录、上传文件、重命名文件等文件管理接口。 文件收藏 包括批量收藏文件、列举收藏文件信息接口。 分享管理-我分享的 包括创建分享、获取分享详情、修改分享等接口。 分享管理-分享给我 包括获取分享详情、退出分享等接口。 分享管理-访问链接 包括获取分享信息、验证分享提取码等接口。 协作门户 包括查询与我有关的文件、查询我最近访问的文件接口。

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T02:02:00.797Z", "ownerId" : "string", "ownerName" : "string", "displayName" : "string", "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:02:00.797Z", "status" : 0, "comment" : "string" } ] }

URI GET /koodrive/ose/v1/share/received 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 最大值：100 pageCursor 否 String 当前页游标，由前一个响应的nextCursor获取 sortType 否 Integer 排序类型，4：分享时间（默认） sortDirection 否 Integer 排序方向，1：升序，2：降序（默认） displayName 否 String 支持按照展示名称模糊匹配

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标，如果不存在，代表已返回最后一个 shareLinks Array of ShareWithMeLink objects 分享链接列表 表4 ShareWithMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 displayName String 展示名称 files Array of ShareFileInfo objects 分享的文件列表 permission SharePermission object 分享权限（后续支持） expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 comment String 分享留言 表5 ShareFileInfo 参数 参数类型 描述 id String *文件id fileName String *文件名，最长160个字节 fileType String 文件类型，外部输入 mimeType String *内容类型 size Integer 文件大小 parentFolder Array of strings 父目录ID列表，注意：当前只取第一个父母Id fileSuffix String 文件后缀，fullFileExtension最后一个字符串 containers Array of strings 空间标识 表6 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标，如果不存在，代表已返回最后一个 link CommonShareLink object 访问链接公共信息 files Array of ShareFile objects 分享文件列表 表4 CommonShareLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 permission SharePermission object 分享权限（后续支持） expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 表5 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限 表6 ShareFile 参数 参数类型 描述 id String *文件id fileName String *文件名，最长160个字节 fileType String 文件类型，外部输入 mimeType String *内容类型 parentFolder Array of strings 父目录ID列表，注意：当前只取第一个父母Id fileSuffix String 文件后缀，fullFileExtension最后一个字符串 size Integer 文件大小 containers Array of strings 空间标识 createdTime String 文件创建时间 editedTime String 文件修改时间

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "link" : { "shareId" : "string", "shortUrl" : "string", "shareTime" : "2024-06-03T02:23:40.607Z", "ownerId" : "string", "ownerName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:23:40.607Z", "status" : 0 }, "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "parentFolder" : [ "string" ], "fileSuffix" : "string", "size" : 0, "containers" : [ "string" ], "createdTime" : "2024-06-03T02:23:40.607Z", "editedTime" : "2024-06-03T02:23:40.607Z" } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表2 请求Body参数 参数 是否必选 参数类型 描述 shortUrl 是 String 分享短码 parentFolder 否 String 父目录id pageSize 否 Integer 每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 pageCursor 否 String 当前页游标，由前一个响应的nextCursor获取 sortType 否 Integer 排序类型，1:文件名排序，2：文件大小排序，4：修改时间排序（默认） sortDirection 否 Integer 排序方向，1：升序，2：降序（默认） kdstoken 否 String 分享临时token refreshCount 否 Boolean 是否刷新计数 fileName 否 String 文件名

请求示例 POST /koodrive/ose/v1/share/files { "shortUrl" : "string", "parentFolder" : "string", "pageSize" : 0, "pageCursor" : "string", "sortType" : 0, "sortDirection" : 0, "kdstoken" : "string", "refreshCount" : true, "fileName" : "string" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 subResponseList Array of ShareSubResponse objects 子响应列表 表4 ShareSubResponse 参数 参数类型 描述 shareId String 分享ID code String 子响应码 message String 子响应信息

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表2 请求Body参数 参数 是否必选 参数类型 描述 shareIds 否 Array of strings 退出分享ID列表

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 list Array of RecentlyAccess objects 最近访问列表 表3 RecentlyAccess 参数 参数类型 描述 operateTime String 操作时间 operType Integer 操作类型；1：查看；2：编辑； file AccessiFileInfo object 文件基本信息 status Integer 状态，1：文件已被删除，2：空间已失效（空间已禁用删除或者当前用户无空间权限） 表4 AccessiFileInfo 参数 参数类型 描述 id String 文件id containerId String 空间id name String 文件名 collaboratorId String 协作用户id collaborator String 协作用户名称 collaborateTime String 协作时间 collaborateType String 协作类型2：编辑；3：分享；4：转存个人空间 fileType String 文件类型， /** * 文件夹 / FOLDER = "10", /* * 图片 / PICTURE = "15", /* * 视频 / VIDEO = "20", /* * word / WORD = "26", /* * excel / EXCEL = "27", /* * ppt / PPT = "28", /* * 音频 / AUDIO = "30", /* * 压缩文件 / ARCHIVE = "35", /* * 应用 / APPLICATION = "40", /* * 其他 */ OTHER = "45", owner String 文件归属者 containerName String 个人空间：空；部门空间：部门名称， containerType Integer 0：部门空间；1：个人空间；2：群组空间 favorite Boolean true：文件被收藏，false：没有被收藏 teamId String 个人空间：空；部门空间：部门id;群组空间：群组id

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "list" : [ { "operateTime" : "2024-06-03T02:26:45.897Z", "operType" : 0, "file" : { "id" : "string", "containerId" : "string", "name" : "string", "collaboratorId" : "string", "collaborator" : "string", "collaborateTime" : "2024-06-03T02:26:45.897Z", "collaborateType" : "string", "fileType" : "string", "owner" : "string", "containerName" : "string", "containerType" : 0, "favorite" : true, "teamId" : "string" }, "status" : 0 } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 业务跟踪id（必须58位） Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink ShareByMeLinkDetail object 我分享的链接详情 表4 ShareByMeLinkDetail 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 分享范围，1：收到连接的所有用户，2：仅企业内用户可访问，3：指定企业用户访问 depts Array of DeptInfo objects 部门列表 groups Array of GroupInfo objects 用户组列表 users Array of UserInfo objects 用户列表 displayName String 展示名称 permission SharePermission object 分享权限（后续支持） extractCode String 提取码 expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 comment String 分享留言 表5 DeptInfo 参数 参数类型 描述 id String 部门id name String 部门名称 表6 GroupInfo 参数 参数类型 描述 id String 用户组id name String 用户组名称 表7 UserInfo 参数 参数类型 描述 id String 用户id name String 用户名称 表8 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T01:59:05.324Z", "scope" : 0, "depts" : [ { "id" : "string", "name" : "string" } ], "groups" : [ { "id" : "string", "name" : "string" } ], "users" : [ { "id" : "string", "name" : "string" } ], "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "extractCode" : "string", "expireTime" : "2024-06-03T01:59:05.324Z", "status" : 0, "comment" : "string" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）

概述 欢迎使用云空间服务（KooDrive）。KooDrive是华为云面向政企等客户推出的数据存储、访问、同步、管理和协作等功能的在线服务，是企业的一站式数字内容中枢，使能企业高效知识协作。 您可以使用本文档提供的API对云空间服务进行相关操作，如新增文件目录、获取文件详情、重命名文件等。支持的全部操作请参见API概览。 在调用KooDrive API之前，请确保已经充分了解KooDrive相关概念，详细信息请参见《产品介绍》。 父主题： 使用前必读

修订记录 发布日期 修订记录 2024-06-05 第四次正式发布。 云盘服务更名云空间服务。 2024-05-17 第三次正式发布。 新增 为什么下载的是警示文件？ “文件元信息未审核/违规”是什么意思？ 批量下载文件/文件夹的文件有缺失？ 复制/分享/转存文件时为什么报错？ 为什么在团队空间上传的文件其他普通用户看不见？ 2023-12-28 第二次正式发布。 新增 批量上传时是否有数量限制或大小限制？ 什么情况下分享状态显示“文件已删除”？ 什么情况下分享状态显示“已失效”？ 是否支持分享文件(夹)给自己？ “分享给我”的页签下显示哪些文件（夹）？ 一次最多可以分享多少个文件或文件夹？ 批量取消或退出分享有数量限制吗？ 收藏列表为什么有置灰的收藏记录？ 最多可批量收藏多少个文件（夹）？ 传输气泡是否会自动消失？ 如果刷新网页，上传任务是否会取消？ 是否支持将自己作为成员加入用户组？ 一个用户最多可以添加多少个用户组？ 同一用户组最多可以添加多少个成员？ 同一用户组最多可以添加多少个成员？ 2023-10-20 第一次正式发布。

访问方式 KooDrive提供Web化的服务管理平台，租户可以通过管理控制台方式访问，用户可以通过Web和API方式访问。 API方式 如果用户需要将KooDrive服务集成到第三方系统，用于二次开发，请使用API方式访问KooDrive，具体操作和描述请参考KooDrive服务的《API参考》。 控制台方式 其他相关操作，请使用管理控制台方式访问KooDrive。 如果用户已注册华为账号并开通华为云，可直接登录管理控制台，从主页选择或搜索“云空间服务 KooDrive”，访问KooDrive。如果未注册，请先注册华为账号并实名认证。请参考以下步骤注册、认证。 打开华为云网站。 单击页面右上角“注册”，根据提示信息完成注册。 实名认证请参考：实名认证。

修订记录 发布日期 修订记录 2024-6-5 第四次正式发布。 云盘服务更名云空间服务。 2023-12-28 第三次正式发布。 更新 什么是云空间服务：增加通过API方式访问KooDrive。 产品功能：增加搜索、收藏、分享文件(夹)，管理用户组、开放API功能介绍。 2023-11-20 第二次正式发布。 更新 权限管理：增加部门管理员管理部门用户、部门空间、用户空间的权限介绍。 2023-10-20 第一次正式发布。

产品功能 KooDrive服务为企业用户提供文件存储和管理、共同协作等企业办公文件类服务，构建企业一站式云空间。 KooDrive服务提供表1中的功能。 表1 KooDrive服务功能概览 功能名称 功能描述 发布区域 组织管理 支持创建企业部门，修改、删除企业部门。 华北-北京四 用户管理 支持添加、修改、禁用/启用、删除用户。 华北-北京四 空间管理 支持管理团队空间和用户个人空间，包括分配、修改、禁用/启用、删除空间。 华北-北京四 文件存储与管理 支持文件夹新建，文件复制、查看详情、重命名、移动、转存、搜索、收藏、删除、彻底删除、恢复功能。 华北-北京四 文件传输 支持文件上传、下载功能，大文件通过分片机制实现上传、下载。 华北-北京四 文件服务 支持在线查看图片缩略图功能。 华北-北京四 文件分享与协作 支持对企业内用户分享文件(夹)，查看、下载、保存分享的文件(夹)。 华北-北京四 工具中心 支持管理用户群组，包括创建、修改、删除群组，添加、移除群组成员。 华北-北京四 回收站管理 支持管理个人回收站和团队回收站内的文件(夹)。包括恢复、彻底删除回收站内文件(夹)，清空回收站。 华北-北京四 API开放 开放部门管理、用户管理、空间管理等接口供第三方进行二次开发使用。 华北-北京四

KooDrive权限 在华为云Console上开通KooDrive的企业租户使用的是华为云账号，开通KooDrive服务后，KooDrive会以该华为云账号创建一个系统管理员账号，用该账号登录KooDrive业务应用后，可以进行组织（部门和用户）和空间管理。通过该系统管理员创建的用户，需要给用户授予角色，才能使得用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限操作KooDrive对应拥有权限的资源。 KooDrive的权限管理采用的基于角色的访问控制的策略，权限与角色相关联，用户通过成为适当角色的成员而得到该角色所赋予的权限。当前KooDrive预置了3个系统角色，分别为系统管理员、部门管理员和普通用户，各个角色赋予的权限参考表1。当前版本不支持用户自定义角色。 表1 KooDrive系统角色 角色名称 赋予权限 角色类型 系统管理员 系统管理员，除不能查看非本人名下的个人空间下的文件以外，其他KooDrive所有的资源均能操作，详细的权限列表如下： 组织管理：组织下所有部门的创建、查询、修改、删除操作。 用户管理：组织下所有部门用户的创建、查询、修改、删除操作。 空间管理：组织下所有部门或个人空间的创建、查询、修改、删除操作。 团队空间：组织下所有部门空间内文件的所有操作，如文件/目录的创建、文件复制、删除等操作。 个人空间：仅能操作属于自己名下的个人空间的文件。 回收站：拥有个人回收站和所有团队回收站的操作权限。 系统角色 部门管理员 部门管理员，拥有该权限的用户可以拥有本部门的操作权限，如管理部门空间和部门成员的个人空间，详细的权限列表如下： 组织管理：查询组织下所有部门列表，部门信息。 用户管理：拥有本部门所有用户的管理权限，如查询本部门用户列表及详情，添加、禁用、删除用户等操作。 空间管理：查询组织下所有部门空间和本部门用户的个人空间，分配、修改、禁用、启用、删除本部门空间和部门成员个人空间。 团队空间：组织下所有部门空间内文件的所有操作，如文件/目录的创建、文件复制、删除等操作。 个人空间：仅能操作属于自己名下的个人空间的文件。 回收站：拥有个人回收站所有的操作权限；拥有本部门回收站所有操作权限。 系统角色 普通用户 普通用户，拥有自己名下个人空间的文件所有操作权限，和所在部门空间的受限操作权限，详细的权限列表如下： 个人空间：操作属于自己名下的个人空间的文件。 团队空间：除不能删除团队空间的文件，拥有其他所有所在部门的空间文件操作权限。 回收站：拥有个人回收站所有的操作权限，无团队回收站操作权限。 系统角色