华为云用户手册

响应示例 状态码： 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", "expireDate" : "3", "status" : 0 }, "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "parentFolder" : [ "string" ], "fileSuffix" : "string", "size" : 0, "containers" : [ "string" ], "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 文件名

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T01:58:35.419Z", "scope" : 0, "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "extractCode" : "string", "expireTime" : "2024-06-03T01:58:35.419Z", "status" : 0, "comment" : "string", "viewCnt" : 0, "downloadCnt" : 0, "saveCnt" : 0, "containerId" : "string", "containerName" : "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 ShareByMeLink objects 分享链接列表 表4 ShareByMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 分享范围，2：仅企业内用户可访问，3：指定企业用户访问 files Array of ShareFileInfo objects 分享的文件列表 displayName String 展示名称 expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 comment String 分享留言 viewCnt Integer 浏览次数 downloadCnt Integer 下载次数（后续支持） saveCnt Integer 转存次数（后续支持） containerId String 分享文件所属空间id containerName String 分享文件所属空间 表5 ShareFileInfo 参数 参数类型 描述 id String *文件id fileName String *文件名，最长160个字节 fileType String 文件类型，外部输入，最长250个字符 mimeType String *内容类型 size Integer 文件大小 parentFolder Array of strings 父目录ID列表，注意：当前只取第一个父母Id fileSuffix String 文件后缀，fullFileExtension最后一个字符串 containers Array of strings 空间标识 downloadLinks Array of downloadLinks objects 下载链接 recycled Boolean 是否在回收站标识 表6 downloadLinks 参数 参数类型 描述 usage String 用途默认：'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段 downloadLink String 下载链接

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data data object 列举压缩包目录响应数据 表4 data 参数 参数类型 描述 uncompressedFileList UncompressedFileinfoList object 压缩包内的文件信息列表，包括所有子文件和子目录。 同步时返回 taskKey String 异步任务key taskValue Object 异步时返回 progress Integer 任务进度，进度百分比的值 taskId String 任务ID，异步时返回 表5 UncompressedFileinfoList 参数 参数类型 描述 code String 错误码 name String 文件名 type String 文件类型 1:内容 2:目录 updateAt String 文件修改时间戳,单位：毫秒（ms) fileSize String 文件或文件夹大小，单位:字节（Byte） 状态码： 400 表6 响应Body参数 参数 参数类型 描述 code String 错误码 msg String 错误描述

请求示例 列举压缩包内文件目录。 POST /ose/v1/archive/listFile Authorization:Bearer+10f88**********4791e9ff { "containerId": "IAADfsBFCO6WtAtuAe3ab00aac61c45e18b0896269d5efb", "fileId": "FvW8fIQFZmz6Fu-lZ-7pKt6wtJISsW0C-", "pwd": " " }

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

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于批量文件处理接口，返回的消息体中部分内容如下所示。 { "data": "1309243162258308352" "code": 0, "msg": "success" } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "code": 13000201, "msg": "inner server invoke failure" } 其中，code表示错误码，msg表示错误描述信息。

Token认证 当前Token有效期为20分钟，20分钟内有调用接口则以调用时间点为基准延长至20分钟，20分钟内无任何操作则Token失效。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token目前采取从服务前端登录后，从cookie获取，如图1所示，“Authorization”的Value值即为要获取的AT。 图1 获取Token 获取Token后，再调用其他接口时，您需要在请求消息头中添加“Authorization”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“Authorization: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/files/batch Content-Type: application/json Authorization: xxx

APP鉴权 可通过koodrive提供的app鉴权生成规则来获取鉴权，将鉴权放入请求头中。 Authorization有效期是15分钟。 示例： Authorization: HMAC-SHA256 AppId=a378331eca141163119eb602adb67b7802cc79cd33ba44c7d2fe61d1586c96a1,SignedHeaders=host;x-date;x-user-id,Signature=bd355f202be40f95bf9510fd7bd48ad711a7d144c01df07d515ee0fbf3a47416 X-User-Id: 1505084218764547200 Host: 10.32.45.165 X-Date: 20240909T033325Z

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 PUT 请求服务器更新指定资源。 在创建批量任务接口的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/jobs

请求消息头 Content-Type：消息体的类型（格式），可选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization：鉴权。 请求消息头示例如下： POST https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/jobs Content-Type: application/json Authorization: xxx

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于批量文件处理接口，请求消息体示例如下： { "taskType":1 "actionType":101 "dstContainerId": IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 "taskInfo": { "srcContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" "newFilePath": "Fm9UdqBNTAQDos6l1xPlFnIqXJg2-UdqA" "fileInfo": [ { "fileId": "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3" } ] } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前KooDrive所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，当前KooDrive只在“华北-北京四”部署，Endpoint为“cn.myhuaweicloud-koodrive.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“创建批量任务”API的resource-path为“/koodrive/ose/v1/jobs”。 query-string 可选参数，用于查询指定参数数据。设置查询参数时，查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要使用KooDrive创建批量任务接口，则需使用“华北-北京四”区域的Endpoint（cn.myhuaweicloud-koodrive.com），并在创建批量任务的URI部分找到resource-path（/koodrive/ose/v1/jobs），拼接起来如下所示。 https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/jobs 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

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

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

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用它进行日常管理工作。 用户 由租户管理员（也称为系统管理员），登录到KooDrive的业务面的控制中心，创建好KooDrive的用户。KooDrive用户登录业务系统后，会生成Access-Token（AT），后续的接口调用都是基于该AT进行认证和鉴权。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 taskList Array of TaskInfo objects 任务列表 code String 响应码 msg String 响应信息 nextCursor String 分页游标，如果不存在，代表已返回最后一个 表4 TaskInfo 参数 参数类型 描述 taskId String 任务id taskName String 任务名称 taskType Integer 任务类型 tenantId String 租户id userId String 用户id status Integer 任务状态 initParams String 拓展字段 locale String 用户所在国家 resultCode String 任务结果 createTime String 任务创建时间 startTime String 任务开始时间 endTime String 任务结束时间

响应示例 状态码： 200 获取任务列表响应 { "taskListDtos" : [ { "taskId" : "1486254586942472064", "taskName" : "ceshi1111", "taskType" : 0, "status" : 2, "createTime" : "2024-08-12T07:22:33.000Z" }, { "taskId" : "1486368980720435072", "taskName" : "ceshi4", "taskType" : 0, "status" : 2, "createTime" : "2024-08-12T11:09:50.000Z" } ], "nextCursor" : 1723549107000, "code" : 0, "msg" : "成功" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Traceid 否 String 消息日志跟踪id(58位) 表2 请求Body参数 参数 是否必选 参数类型 描述 taskType 否 Integer 任务类型（0：移交任务） status 否 Array of integers 任务状态（0：NEW；1：EXECUTING；2：SUC CES S；3：FAILED；） pageSize 否 Integer 每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 pageCursor 否 Long 当前页游标，由前一个响应的nextCursor获取

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 taskId String 任务ID taskName String 任务名称 taskType Integer 任务类型 0：移交并删除； tenantId String 租户标识 userId String 内部userId status Integer 任务状态 0：NEW；1：EXECUTING；2：SUCCESS；3：FAILED； resultCode String 结果码 18xxxxxx：其他具体错误。（任务成功时不返回该参数） code String 响应码 msg String 响应信息

响应示例 状态码： 200 获取任务详情响应。 { "taskId" : "1534087020903704704", "taskName" : "lym0412normal", "taskType" : 0, "tenantId" : "d5ac574bd2934a69baa4f23c55daa8d4", "userId" : "1395497048157130881", "status" : 3, "resultCode" : "18000205", "code" : 0, "msg" : "成功" }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 shareLink ShareWithMeLinkDetail object 分享给我的链接信息 表4 ShareWithMeLinkDetail 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 displayName String 展示名称 permission SharePermission object 分享权限（后续支持） expireTime String 失效时间 status Integer 分享状态，1：文件已被删除 comment String 分享留言 表5 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "string", "ownerId" : "string", "ownerName" : "string", "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:18:51.520Z", "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位）

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 link CommonShareLink object 访问链接公共信息 表4 CommonShareLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 permission SharePermission object 分享权限（后续支持） expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 expireDate String 有效期 表5 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "link" : { "shareId" : "string", "shortUrl" : "string", "shareTime" : "2024-06-03T02:20:24.274Z", "ownerId" : "string", "ownerName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:20:24.274Z", "expireDate" : "3", "status" : 0 } }