华为云用户手册

  • 请求参数 表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表示美式英语,不传默认美式英语
  • 请求参数 表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 空间信息。 { "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 表4 响应Body参数 参数 参数类型 描述 code String 响应码 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 已用空间大小 administrators String 1、当为部门空间时,返回管理员名称,多个管理员通过,隔开; 2、当为群组空间时,返回拥有者名称 tenantId String 租户id creator String 创建者 createTime String 创建时间 modifier String 修改状态 updateTime String 更新时间 userNum String 使用者数量 rootFileId String 云空间根目录id
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于批量文件处理接口,返回的消息体中部分内容如下所示。 { "data": "1309243162258308352" "code": 0, "msg": "success" } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "code": 13000201, "msg": "inner server invoke failure" } 其中,code表示错误码,msg表示错误描述信息。
  • 请求示例 将空间标识为IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 空间下,文件id为FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y的文件重命名为“下载”。 POST /koodrive/ose/v1/files/rename/FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y Authorization:Bearer+10f88*********4791e9ff { "name": "下载", "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "renameMode": 2 }
  • 请求参数 表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表示美式英语,不传默认美式英语
  • 请求参数 表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:个人
  • 请求示例 通过“分片上传”方式创建文件元数据,该示例指定了一个分片,后续响应会返回对应分片的上传地址,需要将对应分片通过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 上传文件第一步完成返回的信息 { "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." }
  • 响应参数 状态码: 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)返回 code String 返回码 msg String 返回信息 表5 MultiPartInfo 参数 参数类型 描述 partNumber Integer 分片编号 最小值:1 最大值:10000 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
  • 响应示例 状态码: 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 String 错误码 msg String 错误信息 data OrgUserInfo object 用户信息 表3 OrgUserInfo 参数 参数类型 描述 role Integer 角色 0:管理员 1:普通用户 2:超级管理员 innerUserId String 用户内部id userName Long 用户内部id orgId String orgId orgName String orgId名称 tenantId String 租户code,这里即企业code userCount String 用户数量 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表示美式英语,不传默认美式英语
  • 请求参数 表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表示美式英语,不传默认美式英语
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 name 是 String 部门名称 parentId 是 String 父部门标识
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 错误码 msg String 错误信息 data String 任务id 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述
  • 请求示例 批量复制文件请求示例。 POST /koodrive/ose/v1/jobs Authorization:Bearer+10f88d07fa************44791e9ff { "taskType":1 , "actionType":101 , "dstContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" , "taskInfo": { "srcContainerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "newFilePath": "Fm9UdqBNTAQDos6l1xPlFnIqXJg2-UdqA" , "fileInfo": [ { "fileId": "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3" } ] } }
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 taskType 是 Integer 任务类型,枚举值: 1:批量复制任务 2:批量删除任务 3:批量移动任务 4:批量还原回收站 5:云解压 6:打包下载 actionType 否 Integer 操作类型,对taskType的细分。仅在taskType为1、2、3时使用 101:复制和转存 201:逻辑删除(移入回收站) 202:彻底删除 301:普通移动 501:查看压缩包 502:全部解压 503:部分解压 taskInfo 是 CreateTaskInfoReq object 创建批量任务请求 dstContainerId 是 String 目标空间ID password 否 String 压缩包密码 表3 CreateTaskInfoReq 参数 是否必选 参数类型 描述 fileInfo 是 Array of fileInfo objects 文件/目录ID newFilePath 否 String 操作文件变更后的新路径 srcContainerId 是 String 源空间的标识 uncompressFilePaths 否 Array of strings 部分解压的文件在压缩包内的全路径列表 表4 fileInfo 参数 是否必选 参数类型 描述 fileId 是 String 文件标识 filePath 否 String 文件全路径,包含fileId
  • 请求示例 获取文件的下载地址,可以通过该下载地址获取文件。 POST /koodrive/ose/v1/files/download Authorization:Bearer+10f88*********4791e9ff { "containerId": "IAADfsBFCO6WtAtuA9add2fea594e4e75b8feb8474ef236", "fileIds": [ "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ" ] }
  • 响应参数 状态码: 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 获取文件下载地址的响应消息 { "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 该字段存储的是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 待获取文件所在的空间的标识 fileIds 是 Array of strings 文件id列表,最大支持传入100个文件id
  • 响应示例 状态码: 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表示美式英语,不传默认美式英语
  • 响应参数 状态码: 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
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 capacity 是 String 申请空间大小 type 是 Integer 空间类型 0:部门 1:个人
  • 响应参数 状态码: 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
  • 响应示例 状态码: 200 部门信息 { "id" : "1319678187126486144", "orgId" : "9190086000001210958", "deptId" : "a4fd0d798f5344ccac2c695646ef66d3", "parentId" : "1245640257345455489", "name" : "test16", "tenantId" : "40086000004871666", "code" : 0, "msg" : "success" }
共100000条