华为云用户手册

  • 请求示例 POST /koodrive/ose/v1/share Authorization:Bearer+10f88**********4791e9ff { "scope": 0, "deptIds": [ "string" ], "groupIds": [ "string" ], "userIds": [ "string" ], "fileIds": [ "string" ], "containerId": "string", "permission": { "preview": true, "edit": true, "download": true }, "extractCode": "string", "expireTime": "2024-06-03T01:54:57.288Z", "comment": "string", "validDays": 0 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink shareLink object 分享链接信息 表5 shareLink 参数 参数类型 描述 shareId String 分享id shortUrl String 分享短码 linkUrl String 分享链接 extractCode String 提取码 comment String 留言 createTime String 创建时间 expireTime String 失效时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error Error object 表7 Error 参数 参数类型 描述 errorData errorData object 异常时候返回给访问者的扩展数据 errorDetail Array of ErrorMsg objects 错误链 code Integer http状态码 description String http状态信息 表8 errorData 参数 参数类型 描述 conflictFileId String 冲突文件ID 表9 ErrorMsg 参数 参数类型 描述 domain String 域 reason String 错误原因 errorCode String 系统内部错误编码, 参见错误码规范 description String 错误描述信息 errorPos String 错误位置类型 errorParam 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 压缩包加密明文
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data data object 列举压缩包目录响应数据 表4 data 参数 参数类型 描述 uncompressedFileList Array of UncompressedFileInfo objects 压缩包内的文件信息列表,包括所有子文件和子目录。 同步时返回 taskId String 任务ID,异步时返回 表5 UncompressedFileInfo 参数 参数类型 描述 containerId String 解压后的空间ID,注:仅解压文件后返回 fileId String 解压后的文件ID,注:仅解压文件后返回 name String 文件或文件夹在压缩包内全路径 fileSize Long 文件大小,(单位B) type Integer 请参考文件类型fileType的定义 1:内容 2:目录 updatedAt Long 文件修改毫秒时间戳 subFileList Array of UncompressedFileInfo objects 子文件和子目录列表(仅对于目录时展开) reason String 失败原因(成功则空) code String 错误码 reservatioinInfo Object 预留字段 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 subResponseList Array of ShareSubResponse objects 子响应列表 表4 ShareSubResponse 参数 参数类型 描述 shareId 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 业务跟踪id(必须58位) 表2 请求Body参数 参数 是否必选 参数类型 描述 shareIds 否 Array of strings 取消分享ID列表
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "extractCode" : "string", "createTime" : "2024-06-03T02:00:39.953Z", "updateTime" : "2024-06-03T02:00:39.953Z", "expireTime" : "2024-06-03T02:00:39.953Z" } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink shareLink object 分享链接信息 表6 shareLink 参数 参数类型 描述 shareId String 分享id shortUrl String 分享链接 extractCode String 提取码 createTime String 创建时间 updateTime String 修改时间 expireTime String 失效时间
  • 请求示例 PUT /koodrive/ose/v1/share/{shareId} { "deptIds" : [ "string" ], "groupIds" : [ "string" ], "userIds" : [ "string" ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:00:39.952Z", "extractCode" : "string", "comment" : "string", "validDays" : 0 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 业务跟踪id(必须58位) 表3 请求Body参数 参数 是否必选 参数类型 描述 deptIds 否 Array of strings 部门id列表 groupIds 否 Array of strings 用户组id列表 userIds 否 Array of strings 用户id列表 permission 否 SharePermission object 分享权限(后续支持) expireTime 否 String 失效时间 extractCode 否 String 提取码 comment 否 String 分享留言 validDays 是 Integer 分享有效天数0-365. 0表示不变 表4 SharePermission 参数 是否必选 参数类型 描述 preview 否 Boolean 预览权限 edit 否 Boolean 编辑权限 download 否 Boolean 下载权限
  • 请求示例 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-Traceid 否 String 业务跟踪id(必须58位) 表2 请求Body参数 参数 是否必选 参数类型 描述 shareId 是 String 分享ID fileId 是 String 文件ID kdstoken 是 String 分享临时token
  • API概览 云空间服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 批量任务操作 包括创建批量任务、取消批量任务、查询批量操作任务列表等批量任务接口。 部门管理 包括创建、修改、删除、查询部门等部门管理接口。 用户管理 包括新建、修改、删除、查询用户等用户管理接口。 空间管理 包括创建、修改、删除、查询空间等空间管理接口。 群组管理 包括创建用户群组、删除群组等接口。 会话管理 包括初始化创建会话、更新会话、登录登出等会话管理接口。 服务订阅 提供业务控制服务获取管理控制服务的订阅状态的接口。 企业设置 提供设置打包下载时生成的压缩包过期清理时间的接口。 云解压 提供列举压缩包目录的接口。 获取文件列表 提供获取个人空间文件列表和群组部门空间文件列表的接口。 文件管理 包括获取文件的详细信息、新增文件目录、上传文件、重命名文件等文件管理接口。 文件收藏 包括批量收藏文件、列举收藏文件信息接口。 分享管理-我分享的 包括创建分享、获取分享详情、修改分享等接口。 分享管理-分享给我 包括获取分享详情、退出分享等接口。 分享管理-访问链接 包括获取分享信息、验证分享提取码等接口。 协作门户 包括查询与我有关的文件、查询我最近访问的文件接口。
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T02:02:00.797Z", "ownerId" : "string", "ownerName" : "string", "displayName" : "string", "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:02:00.797Z", "status" : 0, "comment" : "string" } ] }
  • URI GET /koodrive/ose/v1/share/received 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果 最大值:100 pageCursor 否 String 当前页游标,由前一个响应的nextCursor获取 sortType 否 Integer 排序类型,4:分享时间(默认) sortDirection 否 Integer 排序方向,1:升序,2:降序(默认) displayName 否 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 ShareWithMeLink objects 分享链接列表 表4 ShareWithMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 displayName String 展示名称 files Array of ShareFileInfo objects 分享的文件列表 permission SharePermission object 分享权限(后续支持) expireTime String 失效时间 status Integer 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 comment String 分享留言 表5 ShareFileInfo 参数 参数类型 描述 id String *文件id fileName String *文件名,最长160个字节 fileType String 文件类型,外部输入 mimeType String *内容类型 size Integer 文件大小 parentFolder Array of strings 父目录ID列表,注意:当前只取第一个父母Id fileSuffix String 文件后缀,fullFileExtension最后一个字符串 containers Array of strings 空间标识 表6 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限
  • 请求参数 表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", "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", "status" : 0 }, "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "parentFolder" : [ "string" ], "fileSuffix" : "string", "size" : 0, "containers" : [ "string" ], "createdTime" : "2024-06-03T02:23:40.607Z", "editedTime" : "2024-06-03T02:23:40.607Z" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标,如果不存在,代表已返回最后一个 link CommonShareLink object 访问链接公共信息 files Array of ShareFile objects 分享文件列表 表4 CommonShareLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 permission SharePermission object 分享权限(后续支持) expireTime String 失效时间 status Integer 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 表5 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限 表6 ShareFile 参数 参数类型 描述 id String *文件id fileName String *文件名,最长160个字节 fileType String 文件类型,外部输入 mimeType String *内容类型 parentFolder Array of strings 父目录ID列表,注意:当前只取第一个父母Id fileSuffix String 文件后缀,fullFileExtension最后一个字符串 size Integer 文件大小 containers Array of strings 空间标识 createdTime String 文件创建时间 editedTime String 文件修改时间
  • 请求示例 POST /koodrive/ose/v1/share/files { "shortUrl" : "string", "parentFolder" : "string", "pageSize" : 0, "pageCursor" : "string", "sortType" : 0, "sortDirection" : 0, "kdstoken" : "string", "refreshCount" : true, "fileName" : "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参数 参数 是否必选 参数类型 描述 shareIds 否 Array of strings 退出分享ID列表
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 subResponseList Array of ShareSubResponse objects 子响应列表 表4 ShareSubResponse 参数 参数类型 描述 shareId String 分享ID code String 子响应码 message String 子响应信息
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 list Array of RecentlyAccess objects 最近访问列表 表3 RecentlyAccess 参数 参数类型 描述 operateTime String 操作时间 operType Integer 操作类型;1:查看;2:编辑; file AccessiFileInfo object 文件基本信息 status Integer 状态,1:文件已被删除,2:空间已失效(空间已禁用删除或者当前用户无空间权限) 表4 AccessiFileInfo 参数 参数类型 描述 id String 文件id containerId String 空间id name String 文件名 collaboratorId String 协作用户id collaborator String 协作用户名称 collaborateTime String 协作时间 collaborateType String 协作类型2:编辑;3:分享;4:转存个人空间 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", owner String 文件归属者 containerName String 个人空间:空;部门空间:部门名称, containerType Integer 0:部门空间;1:个人空间;2:群组空间 favorite Boolean true:文件被收藏,false:没有被收藏 teamId String 个人空间:空;部门空间:部门id;群组空间:群组id
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "list" : [ { "operateTime" : "2024-06-03T02:26:45.897Z", "operType" : 0, "file" : { "id" : "string", "containerId" : "string", "name" : "string", "collaboratorId" : "string", "collaborator" : "string", "collaborateTime" : "2024-06-03T02:26:45.897Z", "collaborateType" : "string", "fileType" : "string", "owner" : "string", "containerName" : "string", "containerType" : 0, "favorite" : true, "teamId" : "string" }, "status" : 0 } ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 业务跟踪id(必须58位) Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T01:59:05.324Z", "scope" : 0, "depts" : [ { "id" : "string", "name" : "string" } ], "groups" : [ { "id" : "string", "name" : "string" } ], "users" : [ { "id" : "string", "name" : "string" } ], "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "extractCode" : "string", "expireTime" : "2024-06-03T01:59:05.324Z", "status" : 0, "comment" : "string" } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink ShareByMeLinkDetail object 我分享的链接详情 表4 ShareByMeLinkDetail 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 分享范围,1:收到连接的所有用户,2:仅企业内用户可访问,3:指定企业用户访问 depts Array of DeptInfo objects 部门列表 groups Array of GroupInfo objects 用户组列表 users Array of UserInfo objects 用户列表 displayName String 展示名称 permission SharePermission object 分享权限(后续支持) extractCode String 提取码 expireTime String 失效时间 status Integer 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 comment String 分享留言 表5 DeptInfo 参数 参数类型 描述 id String 部门id name String 部门名称 表6 GroupInfo 参数 参数类型 描述 id String 用户组id name String 用户组名称 表7 UserInfo 参数 参数类型 描述 id String 用户id name String 用户名称 表8 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限
共100000条