华为云用户手册

  • 响应示例 状态码: 200 OK { "shareLink" : { "shareId" : "1537770199275722240", "shortUrl" : "1537770199275722241", "linkUrl" : "https://kdconsole-test-gray.hwcloudtest.cn:8080/cloudfile/#/sharelink/i/1537770199275722241", "extractCode" : "", "comment" : "", "expireTime" : "2024-10-29T09:14:52.948Z" }, "code" : 0, "msg" : "success" }
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 scope 是 Integer 分享范围,2:仅企业内用户可访问,3:指定企业用户访问 deptIds 否 Array of strings 部门id列表 groupIds 否 Array of strings 用户组id列表 userIds 否 Array of strings 用户id列表 fileIds 是 Array of strings 文件id列表 containerId 是 String 空间id permission 否 SharePermission object 分享权限(后续支持) extractCode 否 String 提取码 expireTime 否 String 失效时间 comment 否 String 分享留言 validDays 是 Integer 有效分享天数(1-365) expiredType 否 String 失效类型 表3 SharePermission 参数 是否必选 参数类型 描述 preview 否 Boolean 预览权限 edit 否 Boolean 编辑权限 download 否 Boolean 下载权限
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink shareLink object 分享链接信息 表5 shareLink 参数 参数类型 描述 shareId String 分享id shortUrl String 分享短码 linkUrl String 分享链接 extractCode String 提取码 comment String 留言 expireTime String 失效时间
  • 响应示例 状态码: 200 上传文件第一步完成返回的信息 { "fileId" : "FnkL1QhXj8muHBuSWCHtFFY8Azue44Snr", "containerId" : "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236", "fileName" : "test_20240104_105403.zip", "uploadId" : "0000018CD26464022026422966B8879A", "parentFolder" : [ "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236" ], "exist" : false, "multiParts" : [ { "partNumber" : 1, "partSize" : 22106481, "partOffset" : 0, "uploadUrl" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/ff6b221b4b474c829c1cd5037f1504ca086?partNumber=1&uploadId=0000018CD26464022026422966B8879A&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240104T025403Z&X-Amz-SignedHeaders=content-length%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240104%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=39b9b620c8de901682675059cfcfa9902a13fb5c6ab38fe1451763feb6a8323c" } ], "code" : 0, "msg" : "Success." }
  • 请求示例 通过“分片上传”方式创建文件元数据,该示例指定了一个分片,后续响应会返回对应分片的上传地址,需要将对应分片通过PUT请求上传对应的分片。 POST /koodrive/ose/v1/files/create Authorization:Bearer+10f88*********4791e9ff { "containerId": "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236", "parentFolder": [ "root" ], "createdTime": "2020-05-18T01:43:49Z", "mimeType": "application/x-zip-compressed", "fileType": 35, "fileName": "demo.zip", "sha256": "08a784aeb181506391c20c6355f881dc363d8c3e0739d295e5d6f410d05dbc69", "length": 22106481, "uploadMode": "multipart", "uploadType": 1, "autoRename": 2, "multiParts": [ { "partNumber": 1, "partOffset": 0, "partSize": 22106481 } ], "description": "" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 fileId String 文件id rapidUpload Boolean 是否秒传命中(true表示秒传命中) containerId String 文件所在空间id fileName String 上传后文件名,如果没有重命名则和请求参数的文件名保持一致 uploadId String 文件上传Id parentFolder Array of strings 上传后文件所在父目录Id exist Boolean 文件是否存在,仅在入参autoRename=4时使用,当文件名一致,且文件的sha256一致,返回true multiParts Array of MultiPartInfo objects 分片信息,在分段上传时(uploadMode=multipart)返回 matchedPreHash Boolean 存在匹配的preHash code String 返回码 msg String 返回信息 表5 MultiPartInfo 参数 参数类型 描述 partNumber Integer 分片编号 partSize Long 分片长度,取值范围[5242880, 5368709120],最后一个分片取值范围[0, 5368709120] minimum: 0 maximum: 5368709120 partOffset Long 到上一个数据块为止的总长度,单位为字节,该字段仅在分片并行上传时有效,分片并行上传时,除最后一个分片外,分片并行上传的其它分片大小,必须是 64字节的倍数 hashCtx Array of longs 用于迭代计算SHA256的上下文,该字段仅在分片并行上传时有效。对于SHA1,取值为上一个数据块SHA1的第1-5个32位变量。对于SHA256,取值为上一个数据块SHA256的第1-8个32位变量。 注:分片并行上传时除第一个分片外其他分片必填。 uploadUrl String 文件上传的URL,返回参数 partId String 分片对象ID
  • 请求示例 在IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4空间下的根目录创建文件夹。 POST /koodrive/ose/v1/directory Authorization:Bearer+10f88*********4791e9ff { "createdTime": "", "editedTime": "", "description": "222", "mimeType": "application/vnd.huawei-apps.folder", "fileName": "ttgg", "fileType": "10", "parentFolder": [ "root" ], "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "renameMode": "2" }
  • 请求示例 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-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 fileId 是 String 上传完成的文件id sha256 否 String 用SHA256计算的文件完整摘要信息
  • 请求示例 清空空间id为IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4的空间下回收站的文件。 POST /koodrive/ose/v1/files/recycle Authorization:Bearer+10f88*********4791e9ff {   "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" }
  • 请求参数 表1 请求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表示美式英语,不传默认美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 containerId 是 String 空间标识
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 status Integer 响应状态,0:全部成功,1:部分成功,2:全部失败 subResponseList Array of SubResponse objects 子响应列表 表5 SubResponse 参数 参数类型 描述 fileId 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 消息日志跟踪标识(必须58位) 表2 请求Body参数 参数 是否必选 参数类型 描述 starred 是 Boolean 是否收藏 subRequestList 是 Array of StarFileRequest objects 批量收藏文件列表 表3 StarFileRequest 参数 是否必选 参数类型 描述 containerId 是 String 空间id fileId 是 String 文件id,不允许重复
  • 请求参数 表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表示美式英语,不传默认美式英语 表3 请求Body参数 参数 是否必选 参数类型 描述 userIds 是 Array of strings 用户Id列表
  • 请求示例 批量删除群组369528171409614001中的用户。 POST /koodrive/ose/v1/usergroups/369528171409614001/members/batchDelete Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad { "userIds": ["3432423464657862424","132543141414141414"] }
  • 请求参数 表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列表,一次最多100
  • 响应示例 状态码: 200 用户信息 { "data": { "role": "2", "userName": "租户管理员", "innerUserId": "369528171409614001", "userId": "1008600000016806899", "tenantId": "40086000004871666", "orgId": "9190086000001210958", "orgName": "KooDrive-不要删", "deptId":1395496464656556464 "userCount": 7000 }, "code": 0, "msg": "success" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 code Integer 错误码 msg String 错误信息 data OrgUserInfo object 用户信息 表3 OrgUserInfo 参数 参数类型 描述 role String 角色 0:管理员 1:普通用户 2:超级管理员 innerUserId String 用户内部id userName String 用户名 orgId String orgId orgName String orgId名称 tenantId String 租户code,这里即企业code userCount Integer 用户数量 deptId String 部门id
  • 请求参数 表1 请求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表示美式英语,不传默认美式英语
  • 请求示例 更新部门1289173650183882753群组信息。 PUT /koodrive/ose/v1/usergroup/1289173650183882753 Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad { "groupName": "123", "sourceType": 0 }
  • 请求参数 表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表示美式英语,不传默认美式英语 表3 请求Body参数 参数 是否必选 参数类型 描述 groupName 是 String 用户组名 userId 否 String 用户ID role 否 String 用户组角色 iconUrl 否 String 团队头像链接 top 否 String 置顶标识。1表示置顶,0标识按顺序展示 sourceType 是 Integer 用户组类型
  • 请求参数 表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表示美式英语,不传默认美式英语 表3 请求Body参数 参数 是否必选 参数类型 描述 deptId 否 Long KooDrive的部门标识 role 否 Integer 角色 0:管理员 1:普通用户 2:超级管理员 status 否 Integer 用户账号的状态 0:启用(可正常登录) 1:禁用(不可登录)
  • 请求参数 表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表示美式英语,不传默认美式英语 表3 请求Body参数 参数 是否必选 参数类型 描述 status 否 String 云空间状态: 0:正常(已分配空间,且可正常使用) 1:禁用(已分配空间,但禁止访问已用空间) capacity 否 String 容量 type 是 Integer 空间类型 0:部门 1:个人
  • 请求示例 修改部门1319678187126486144的相关信息。 PUT /koodrive/ose/v1/departments/1319678187126486144 Authorization:Bearer+10f88**********4791e9ff { "name" : "test16", "parentId" : "1243696974704704000" }
  • 请求参数 表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表示美式英语,不传默认美式英语 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 部门名称 parentId 是 String 父部门标识
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh_cn表示简体中文,en_us表示美式英语 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 表2 请求Body参数 参数 是否必选 参数类型 描述 tenantId 否 String 租户标识 packageDownloadExpires 是 Integer 打包下载时生成的临时压缩包过期清理时间,默认值7.取值范围[1, 30]
  • 请求示例 搜索文件请求示例。 POST /koodrive/ose/v1/files/search Authorization:Bearer+10f88*********4791e9ff { "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 }
  • 响应参数 状态码: 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 downLoadLinks objects 图片类型返回,缩略图地址 teamName String 团队空间返回,部门名称或者群组空间名称 teamId String 群组id,即部门的id或者群组的id containerId String 空间id containerType String 0:部门空间,1:个人空间,2:群组空间 favorite Boolean 个人空间、团队空间返回文件是否被当前用户收藏 owner String 团队空间返回owner名称 表8 downLoadLinks 参数 参数类型 描述 usage String 用途,thumbnail缩略图,content内容 downloadLink String 图片地址
共100000条