华为云用户手册

请求示例 批量复制文件请求示例。 POST /koodrive/ose/v1/jobs Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "taskType":1 , "actionType":101 , "dstContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" ， "taskInfo": { "srcContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"， "newFilePath": "Fm9UdqBNTAQDos6l1xPlFnIqXJg2-UdqA" ， "fileInfo": [ { "fileId": "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3" } ] } }

API概览 云盘服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 批量任务操作 包括创建批量任务、取消批量任务、查询批量操作任务列表等批量任务接口。 部门管理 包括创建、修改、删除、查询部门等部门管理接口。 用户管理 包括新建、修改、删除、查询用户等用户管理接口。 空间管理 包括创建、修改、删除、查询空间信息等空间管理接口。 会话管理 包括初始化创建会话、更新会话、登录登出等会话管理接口。 服务订阅 提供业务控制服务获取管理控制服务的订阅状态的接口。 组织管理 提供查询企业组织信息的接口。 获取文件列表 提供获取个人空间文件列表和群组部门空间文件列表的接口。 文件管理 包括获取文件的详细信息，新增文件目录、上传文件、重命名文件等文件管理接口。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String CS RF Token

响应示例 状态码： 200 组织信息 { "data" : { "organizationCode" : "9190086000001210958", "name" : "KooDrive-不要删", "briefName" : "KooDrive-不要删", "domain" : "koodrivetest.huaweiapaas.com" }, "code" : 0, "msg" : "成功" }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 x-request-id String 任务跟踪的请求ID号 表4 响应Body参数 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 msg String 错误描述 最小长度：2 最大长度：512 data Array of OrganizationInfo objects 组织信息 表5 OrganizationInfo 参数 参数类型 描述 organizationCode String 组织外部编码，系统唯一 最小长度：1 最大长度：64 name String 组织名称 最小长度：1 最大长度：128 briefName String 组织简称 最小长度：1 最大长度：128 domain String 组织域名，系统唯一 最小长度：1 最大长度：128 logo String 组织Logo，已上传文件服务器的文件url地址 最小长度：1 最大长度：1024

请求示例 查询组织信息请求。 GET /koodrive/ose/v1/organization/9190086000001210958 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5

请求示例 获取文件的下载地址，可以通过该下载地址获取文件。 POST /koodrive/ose/v1/files/download Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "containerId": "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236", "fileIds": [ "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ" ] }

响应示例 状态码： 200 文件详情 { "downloads" : [ { "fileId" : "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ", "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/5e3fc0c5d4fa45338f44db7177579c2c087?response-content-disposition=attachment%3B%20filename%3D%22%25E5%258F%2591%25E7%25A5%25A81.pdf%22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231227T072939Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20231227%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=9d06798af17e2f1082b720f43af29a32b3154da4ddeee4f10025a758b599728a", "fileName" : "发票1.pdf", "code" : "0", "msg" : "success" } ], "batchCode" : 1, "code" : 0, "msg" : "Success." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 业务跟踪id language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String CSRF Token 表2 请求Body参数 参数 是否必选 参数类型 描述 containerId 是 String 待获取文件所在的空间的标识 fileIds 是 Array of strings 文件id列表，最大支持传入100个文件id

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 返回码 msg String 返回信息 batchCode Integer 批量返回码，枚举值： 0：部分成功 1：全部成功 2：全部失败 downloads Array of DownloadInfoResponse objects 下载地址信息 表4 DownloadInfoResponse 参数 参数类型 描述 fileId String 文件标识 fileName String 文件名 url String 下载地址 code String 单条下载记录返回码 msg String 单条下载记录返回信息

响应示例 状态码： 200 返回组织下或某个部门下子部门列表 { "list" : [ { "id" : "1248723349513736065", "orgId" : "9190086000001210958", "deptId" : "b06f091567064db9a1f6a7dc8d08e8a7", "parentId" : "1245640257345455489", "name" : "sub11rt", "tenantId" : "40086000004871666" }, { "id" : "1252924812435692416", "orgId" : "9190086000001210958", "deptId" : "f63c3008420c4c55b3963b6191096e2e", "parentId" : "1245640257345455489", "name" : "1234666", "tenantId" : "40086000004871666" } ], "code" : 0, "msg" : "success" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String Csrf Token

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 返回码 msg String 返回信息 data Array of departmentInfo objects 部门信息列表 表4 departmentInfo 参数 参数类型 描述 code String 响应码 msg String 响应信息 id String 部门标识 orgId String OrgID中创建的组织的ID deptId String OrgID中创建的部门的ID parentId String kooDrive中的父部门ID name String 部门名称 tenantId String 租户ID

请求示例 查询部门1245640257345455489下子部门列表。 GET https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/departmentList?departmentId=1245640257345455489 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String Csrf Token 表3 请求Body参数 参数 是否必选 参数类型 描述 capacity 是 String 申请空间大小 type 是 Integer 空间类型 0：部门 1：个人

请求示例 为部门1289173650183882753创建1G的空间。 POST https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/space/1289173650183882753 Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad X-Csrf-Token:dad0fe63fd342b5ff8290a1c58c010cbb92d94c103cc36f2 { "capacity": 1, "type": 0 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String Csrf Token

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 id String 部门标识 orgId String OrgID中创建的组织的ID deptId String OrgID中创建的部门的ID parentId String kooDrive中的父部门ID name String 部门名称 tenantId String 租户ID

请求示例 查询部门1319678187126486144信息。 GET https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/departments/1319678187126486144 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5

响应示例 状态码： 200 部门信息 { "id" : "1319678187126486144", "orgId" : "9190086000001210958", "deptId" : "a4fd0d798f5344ccac2c695646ef66d3", "parentId" : "1245640257345455489", "name" : "test16", "tenantId" : "40086000004871666", "code" : 0, "msg" : "success" }

请求示例 搜索文件请求示例。 POST /koodrive/ose/v1/files/search Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "searchType" : " personal/team", "pageInfo" : { "pageSize" : 100, "pageCursor" : 1 }, "filter" : { "keyWord" : "材料", "containerId" : "123456", "parentFolder" : "1", "fileType" : "1", "sizeRang" : "1024,2048", "updateTimeRange" : "2023-11-02,2023-11-21", "ownerId" : "归属用户id" } }

响应示例 状态码： 200 搜索结果 { "code" : 0, "msg" : "success", "files" : [ { "id" : "Abc", "fileName" : "Abc", "fileType" : "1", "size" : "1024", "updateTime" : "2023-05-26T02:08:53.683Z", "namePath" : "", "downloadLinks" : "", "deptName" : "" } ], "total" : 1000 }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-trace-id 是 String 消息日志跟踪标识 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String CSRF Token 表2 请求Body参数 参数 是否必选 参数类型 描述 searchType 是 String 查询类型：个人空间、团队空间 pageInfo 是 pageInfo object 分页信息 filter 否 filter object 过滤器 sortInfo 否 sortInfo object 排序信息 recycled 否 Boolean 是否查询回收站，枚举值： true：查回收站文件 false：查对应空间非回收站 缺省值：false recursived 否 Boolean 是否递归查询子目录文件，默认false 表3 pageInfo 参数 是否必选 参数类型 描述 pageSize 是 Integer 每页大小 最小值：1 最大值：100 pageCursor 是 String 起始游标，为空时从第一页开始查询 表4 filter 参数 是否必选 参数类型 描述 keyWord 否 String 文件名称，模糊匹配 最小长度：1 最大长度：255 containerId 否 String 空间id，指定父目录时必传 parentFolder 否 String 父目录 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"); updateTimeRange 否 String 最后更新时间区间 ownerId 否 String 文件所有者 表5 sortInfo 参数 是否必选 参数类型 描述 sortType 否 String 枚举类型： fileName：文件名 size：文件大小 type：文件格式 updateTime：最后更新时间 createTime：创建时间 recycledTime：删除时间 fileSuffix：文件格式小类 sortDirection 否 String 枚举类型： desc：降序 asc：升序列

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 code Integer 响应码，成功返回0，失败返回错误码 msg String 成功、错误信息 files Array of files objects 搜索结果 total Integer 总数 nextPageCursor String 下一页起始游标，最后一页值为空 表7 files 参数 参数类型 描述 id String 文件id fileSuffix String 文件后缀 fileName String 文件名 fileType String 文件类型 size String 文件大小 updateTime String 最后更新时间 namePath String 名称全路径 idPath String id全路径 downloadLinks Array of DownLoadLink objects 图片类型返回，缩略图地址 deptName String 部门空间返回，部门名称 deptId String 部门id，即部门表的id containerId String 空间id favorite Boolean 个人空间、团队空间返回文件是否被当前用户收藏 owner String 团队空间返回owner名称 表8 DownLoadLink 参数 参数类型 描述 usage String 用途，thumbnail缩略图，content内容 downloadLink String 图片地址

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 date SpaceInfo object 空间信息 表4 SpaceInfo 参数 参数类型 描述 type String 所有者类型 status String 状态 ownerId String 云空间所有者 containerId String 云空间ID bizRootFileId String 业务根目录ID，存储未加密的普通文件 bizSboxFileId String 业务保险箱目录ID，存储加密的文件 capacity String 空间大小 spaceUsed String 已用空间大小 administrators String 如果是部门空间，同时返回部门空间的管理员

请求示例 查询空间标识为IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b的空间详情。 GET https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/space/container/IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad X-Csrf-Token:dad0fe63fd342b5ff8290a1c58c010cbb92d94c103cc36f2

响应示例 状态码： 200 空间详情。 { "data" : { "tenantId" : "40086000004871666", "creator" : "369528171409614001", "createTime" : "2023-11-14T20:39:06.000Z", "modifier" : "369528171409614001", "updateTime" : "2023-12-27T03:41:49.000Z", "ownerId" : "1289173668999530369", "type" : 0, "status" : 0, "capacity" : 1, "spaceUsed" : 654777, "containerId" : "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b", "rootFileId" : "HFaETMi24qYqOM5KQmpNY2ATjKJeAunIK", "bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b", "bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" }, "code" : 0, "msg" : "成功" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String Csrf Token

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 X-Csrf-Token 是 String Csrf Token