华为云用户手册

响应示例 状态码： 200 获取空间信息响应 { "data" : { "tenantId" : "0929b397a3424384b32cf8f96d9f35e4", "creator" : "1465814559892958208", "modifier" : "1465814559892958208", "ownerId" : 1517293342025685000, "type" : 1, "status" : 0, "capacity" : 1, "spaceUsed" : 0, "containerId" : "IAACk0hRXpq9DAWkA1537830432752646913", "rootFileId" : "HFNKeRWAxXJU4ittbTKM7OQCFOOojMDWV", "bizRootFileId" : "DFFemr0MBaQArootIAACk0hRXpq9DAWkA1537830432752646913", "bizSboxFileId" : "DFFemr0MBaQAsboxIAACk0hRXpq9DAWkA1537830432752646913", "operatorId" : 1465814559892958200, "name" : "121-2" }, "code" : 0, "msg" : "操作成功。" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 Authorization 是 String 格式“Bearer {app_access_token}”，需传入应用级token，用于应用服务端调用，通过创建应用时获得的clientid及clientSecret调用接口获取 2. 此处应用为KooDrive服务端

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code Integer 信息码 msg String 信息 data Array of SpaceInfoV2 objects 空间信息列表 表5 SpaceInfoV2 参数 参数类型 描述 type String 所有者类型 0：部门空间 1：个人空间 2：群组空间 status String 状态 ownerId String 云空间所有者 1、当为部门空间时，返回部门ID 2、当为个人空间时，返回用户ID 3、当为群组空间时，返回群组ID containerId String 云空间ID bizRootFileId String 业务根目录ID，存储未加密的普通文件 bizSboxFileId String 业务保险箱目录ID，存储加密的文件 capacity String 空间大小 spaceUsed String 已用空间大小 tenantId String 租户id creator String 创建者 modifier String 修改者id rootFileId String 云空间根目录id

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应消息 data SpaceInfo object 空间信息 表4 SpaceInfo 参数 参数类型 描述 type String 所有者类型 0：部门空间 1：个人空间 2：群组空间 status String 状态 ownerId String 云空间所有者 1、当为部门空间时，返回部门ID 2、当为个人空间时，返回用户ID 3、当为群组空间时，返回群组ID containerId String 云空间ID bizRootFileId String 业务根目录ID，存储未加密的普通文件 bizSboxFileId String 业务保险箱目录ID，存储加密的文件 capacity String 空间大小 spaceUsed String 已用空间大小 tenantId String 租户id creator String 创建者 createTime String 创建时间 modifier String 修改者id updateTime String 更新时间 rootFileId String 云空间根目录id

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应消息 data SpaceInfo object 空间信息 表5 SpaceInfo 参数 参数类型 描述 type String 所有者类型 0：部门空间 1：个人空间 2：群组空间 status String 状态 ownerId String 云空间所有者 1、当为部门空间时，返回部门ID 2、当为个人空间时，返回用户ID 3、当为群组空间时，返回群组ID containerId String 云空间ID bizRootFileId String 业务根目录ID，存储未加密的普通文件 bizSboxFileId String 业务保险箱目录ID，存储加密的文件 capacity String 空间大小 spaceUsed String 已用空间大小 tenantId String 租户id creator String 创建者 createTime String 创建时间 modifier String 修改者id updateTime String 更新时间 rootFileId String 云空间根目录id

响应示例 状态码： 200 空间信息。 { "data" : { "tenantId" : "40086000004871666", "creator" : "369528171409614001", "createTime" : "2023-11-07T20:36:35.000Z", "modifier" : "369528171409614001", "updateTime" : "2023-12-26T11:40:07.000Z", "ownerId" : "369528171409614001", "type" : 1, "status" : 0, "capacity" : 800, "spaceUsed" : 91966408, "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "rootFileId" : "HFFdIb642fU51JWKAUlP6mwUVc8oDNKbO", "bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" }, "code" : 0, "msg" : "成功" }

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

响应示例 状态码： 200 服务状态 { "data": { "tenantId": "40086000004871666", "status": 0, "spaceCapacity": 10000, "userCount": 7000, "personalSpaceSize": 0, "groupSpaceSize": 10, "organizationName": "KooDrive-不要删", "organizationId": "9190086000001210958", "rootDeptCode": "aed8a3763f9b4177beb2dd8bce1a3885", "departmentSpaceSize":0 "productType":"2" "wpsAvailable":true "aiAvailable": true }, "code": 0, "msg": "成功" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应消息 data ServiceStatus object 云服务订购状态 表3 ServiceStatus 参数 参数类型 描述 status Integer 服务状态 0：正常（云服务正常，比如解冻操作） 1：冻结（资源和数据会保留，但租户无法再正常使用云服务） spaceCapacity Integer 云空间配额 userCount Integer OrgID用户配额 groupSpaceSize Integer 默认开通团队空间大小。为0时表示不开通 personalSpaceSize Integer 默认开通个人空间大小。为0时表示不开通 organizationName String 组织名称 organizationId String 组织标识 rootDeptCode String OrgID创建组织后自动创建的根部门编码 tenantId String 租户标识 departmentSpaceSize Integer 默认开通部门空间大小。为0时表示不开通 aiAvailable Boolean 是否启用ai wpsAvailable Boolean 是否启用wps productType String 产品类型

请求参数 表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表示美式英语，不传默认美式英语

响应示例 状态码： 200 查询服务使用量响应 { "data" : { "spaceUsed" : 7753298, "spaceCapacity" : 10240, "deptSpaceQuota" : 6144, "personalSpaceQuota" : 2048, "groupSpaceQuota" : 2048, "reservedSpaceQuota" : 0, "spaceQuotaUsed" : 327, "deptSpaceUsed" : 1975057, "deptSpaceQuotaUsed" : 42, "personalSpaceUsed" : 3933426, "personalSpaceQuotaUsed" : 35, "groupSpaceUsed" : 1844815, "groupSpaceQuotaUsed" : 250, "userCount" : 20, "userMaxCount" : 100, "packageDownloadExpires" : 7, "productType" : "1" }, "code" : 0, "msg" : "success" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应消息 data data object 服务当前使用量 表3 data 参数 参数类型 描述 spaceQuotaUsed Integer 云空间配额使用量 userCount Integer OrgID已建用户数 spaceCapacity Integer 租户订购空间总容量；单位：GB userMaxCount Integer 租户订购的最大使用人数 spaceUsed Integer 空间使用量 deptSpaceQuota Integer 部门空间配额 personalSpaceQuota Integer 个人空间配额 groupSpaceQuota Integer 群组空间配额 reservedSpaceQuota Integer 保留的空间配额 deptSpaceUsed Integer 部门空间使用量 deptSpaceQuotaUsed Integer 部门空间配额使用量 personalSpaceUsed Integer 个人空间使用量 personalSpaceQuotaUsed Integer 个人空间配额使用量 groupSpaceUsed Integer 群组空间使用量 groupSpaceQuotaUsed Integer 群组空间配额使用量 packageDownloadExpires Integer 打包下载过期时间 productType String 产品类型

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data Array of JobInfo objects 批量任务列表信息 表4 JobInfo 参数 参数类型 描述 taskId String 任务标识 taskType Integer 任务类型 actionType Integer 操作类型 status Integer 任务状态 0:待处理 1:处理中 2:已完成 3:已取消 taskResultCode Integer 任务处理结果 1:全部成功 2:部分失败 3:全部失败 resultCode Integer 任务处理结果码 contentNum Integer 请求文件数量 containerId String 目标空间ID，跨空间场景时取目标空间ID tenantId String 租户标识 beginTime String 任务开始时间 endTime String 任务结束时间 createTime String 任务创建时间 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述

响应示例 状态码： 200 返回查询到的任务列表 { "data" : [ { "taskId" : "1320279189273965056", "taskType" : 2, "actionType" : 201, "status" : 2, "taskResultCode" : 1, "contentNum" : 1, "containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236", "beginTime" : "20231227151904", "endTime" : "20231227151904", "createTime" : "20231227151904" }, { "taskId" : "1320279092268104960", "taskType" : 2, "actionType" : 201, "status" : 2, "taskResultCode" : 1, "contentNum" : 4, "containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236", "beginTime" : "20231227151852", "endTime" : "20231227151852", "createTime" : "20231227151852" } ], "code" : 0, "msg" : "成功" }

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

URI GET /koodrive/ose/v1/jobs 表1 Query参数 参数 是否必选 参数类型 描述 type 否 Integer 任务类型，枚举值： 1：批量复制任务 2：批量删除任务 3：批量移动任务 4：批量还原回收站 5：云解压 6：打包下载 status 否 Integer 任务状态 0:待处理 1:处理中 2:已完成 3:已取消 offset 是 Integer 偏移量，最小值为0 limit 是 Integer 最大返回个数。最小值为1，最大值为100

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

响应示例 状态码： 200 返回查询到的任务详情 { "data" : { "jobInfo" : { "taskId" : "1309243162258308352", "userId" : "40086000004871666-369528171409614001", "taskType" : 1, "actionType" : 101, "status" : 2, "progress" : 100, "taskResultCode" : 1, "contentNum" : 1, "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "tenantId" : "40086000004871666", "beginTime" : "20231212095227", "endTime" : "20231212095227", "createTime" : "20231212095227" }, "taskInfos" : [ { "fileId" : "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3", "status" : "1", "newFileId" : "FtEXHCpfqHueAHFbEmWZNkqUH_K866MVn", "srcContainerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" } ] }, "code" : 0, "msg" : "成功" }

响应示例 状态码： 200 群组空间列表信息。 { "total": 1, "groupsTotal": 1, "groupsMax": 500, "assignedCapacity": 100, "maxCapacity": 2048, "groups": [ { "tenantId": "cad444830661464d9da88784a96d960c", "creator": "1410172329509745795", "createTime": "2024-05-10T01:46:22.000Z", "modifier": "1410172329509745795", "updateTime": "2024-05-10T02:27:23.000Z", "ownerId": "1410172329509745795", "status": 0, "capacity": 20, "spaceUsed": 0, "containerId": "IAAE49hOR8LulgAAA1417956457328121729", "bizRootFileId": "DE5Hwu6WAAAArootIAAE49hOR8LulgAAA1417956457328121729", "bizSboxFileId": "DE5Hwu6WAAAAsboxIAAE49hOR8LulgAAA1417956457328121729", "id": "1417956457311344513", "groupName": "api01", "iconUrl": "1", "ownerName": "hid99522477", "userNum": 1 }, "code" : 0, "msg" : "成功" }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 错误码 msg String 错误信息 total Integer 总数 groupsTotal Integer 群组总数 groupsMax Integer 最大群组数 assignedCapacity String 已分配容量 maxCapacity String 最大容量 groups Array of GroupSpaceInfo objects 群组空间信息 表4 GroupSpaceInfo 参数 参数类型 描述 id String 空间所属的部门ID、用户组ID或群组ID status Integer 空间状态 capacity Integer 空间大小 spaceUsed String 已用空间大小 containerId String 云空间标识 userNum Integer 用户数 ownerId String 拥有者ID ownerName String 拥有者名称 tenantId String 租户标识 creator String 创建者 createTime String 创建时间 modifier String 修改者id updateTime String 更新时间 bizRootFileId String 云空间根目录id bizSboxFileId String 云空间保险箱目录id iconUrl String 图标链接 name String 空间名称

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

响应示例 状态码： 200 全路径信息 { "fileIdPath" : "/DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4/FkbdCAceMj89bprz5xLJASID1eaRqjlRP/FqIAmBlIz7ovbThxeUBlOpbnCHaP_MTUL/FqS6hLLy_DkjlWdfOnEdCErhsmokRvdXI", "namePath" : "/rootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4/007/001/批量任务测试", "code" : 0, "msg" : "成功" }

响应示例 状态码： 200 部门空间列表信息。 { "total" : 364, "departments" : [ { "tenantId" : "40086000004871666", "creator" : "369528171409614001", "createTime" : "2023-11-14T20:39:06.000Z", "modifier" : "369528171409614001", "updateTime" : "2023-12-26T11:40:08.000Z", "ownerId" : "1289173668999530369", "status" : 0, "capacity" : 1, "spaceUsed" : 654777, "containerId" : "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b", "bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b", "bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b", "id" : "1289173668999530369", "parentId" : "1289171275545118721", "name" : "部门1699953477584", "userNum" : 1 }, { "tenantId" : "40086000004871666", "id" : "1289173650183882753", "parentId" : "1289171275545118721", "name" : "部门1699953475619" }, { "tenantId" : "40086000004871666", "id" : "1289173631275960193", "parentId" : "1289171275545118721", "name" : "部门1699953473454" }, { "tenantId" : "40086000004871666", "id" : "1289173612200265729", "parentId" : "1289171275545118721", "name" : "部门1699953470101" }, { "tenantId" : "40086000004871666", "id" : "1289173593258788737", "parentId" : "1289171275545118721", "name" : "部门169995346896" }, { "tenantId" : "40086000004871666", "id" : "1289173574392809473", "parentId" : "1289171275545118721", "name" : "部门1699953466973" }, { "tenantId" : "40086000004871666", "id" : "1289173555140953985", "parentId" : "1289171275545118721", "name" : "部门1699953463567" }, { "tenantId" : "40086000004871666", "id" : "1289173535931041664", "parentId" : "1289171275545118721", "name" : "部门1699953461741" }, { "tenantId" : "40086000004871666", "id" : "1289173517174114305", "parentId" : "1289171275545118721", "name" : "部门1699953459399" }, { "tenantId" : "40086000004871666", "id" : "1289173498115196929", "parentId" : "1289171275545118721", "name" : "部门1699953457405" } ], "code" : 0, "msg" : "成功" }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 错误码 msg String 错误信息 total String 总数 departments Array of departmentSpaceInfo objects 部门空间信息 表4 departmentSpaceInfo 参数 参数类型 描述 id String 部门ID parentId String kooDrive中的父部门ID name String 部门名称 tenantId 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 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识（必须58位） language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语