华为云用户手册

  • 请求参数 表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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权
  • URI DELETE /koodrive/ose/v1/space/{owner_id} 表1 路径参数 参数 是否必选 参数类型 描述 owner_id 是 String 拥有者标识 表2 Query参数 参数 是否必选 参数类型 描述 type 是 Integer 空间类型 0:部门 1:个人 containerId 否 String 空间id,三方集成时存在多个个人空间,删除时需指定containerId
  • 请求参数 表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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 表3 请求Body参数 参数 是否必选 参数类型 描述 status 否 String 云空间状态: 0:正常(已分配空间,且可正常使用) 1:禁用(已分配空间,但禁止访问已用空间) capacity 否 String 容量 type 是 Integer 空间类型 0:部门 1:个人 containerId 否 String 空间id
  • 响应示例 状态码:200 响应体 { "total" : 1, "data" : [ { "id" : "***", "name" : "*****", "description" : "", "templateType" : 1, "status" : 1, "company" : "*****", "createTime" : "2025-01-03T08:15:14.339Z", "updateTime" : "2025-01-03T08:54:47.814Z", "capabilities" : { "addChildNodePermission" : false, "copyPermission" : false, "deletePermission" : false, "downloadPermission" : false, "editPermission" : false, "listChildNodePermission" : true, "removeChildNodePermission" : false, "renameFilePermission" : false, "shareFilePermission" : false, "uploadPermission" : false, "viewPermission" : false } } ], "code" : 0, "msg" : "成功" }
  • URI GET /koodrive/ose/v1/permission/template/list 表1 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 最大返回个数。最小值为1,最大值为100 offset 是 Integer 偏移量,最小值为0 id 否 Long 权限模板的唯一id。 templateType 否 Integer 权限模板的类型;0是预置模板,1是自定义模板。 status 否 Integer 权限模板的状态;0是禁用,1是启用。 orderByTime 否 Integer 按createTime排序,0表示降序,1表示升序,该值仅能填0或1。 preBefore 否 Boolean 规定预置模板排在前还是后
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 data Array of PermissionTemplate objects 权限模板信息 total Integer 当前企业下权限模板总数(包括预置模板) 表4 PermissionTemplate 参数 参数类型 描述 id String 权限模板的唯一id。 name String 权限模板的名称。 description String 权限模板的描述信息。 templateType Integer 权限模板的类型;0是预置模板,1是自定义模板。 status Integer 权限模板的状态;0是禁用,1是启用。 company String 权限模板归属的企业。可以是orgid,也可以是appid。 createTime String 权限模板的创建时间。 updateTime String 权限模板的更新时间。 capabilities Capabilities object 权限值。 表5 Capabilities 参数 参数类型 描述 addChildNodePermission Boolean 新建文件/文件夹权限;true有权限,false无权限。 copyPermission Boolean 复制权限;true有权限,false无权限。 deletePermission Boolean 删除权限;true有权限,false无权限。 downloadPermission Boolean 下载权限;true有权限,false无权限。 editPermission Boolean 编辑权限;true有权限,false无权限(暂不支持编辑)。 listChildNodePermission Boolean 可见列表权限;true有权限,false无权限。 removeChildNodePermission Boolean 移动权限;true有权限,false无权限。 renameFilePermission Boolean 重命名权限;true有权限,false无权限。 shareFilePermission Boolean 分享权限;true有权限,false无权限。 uploadPermission Boolean 上传权限;true有权限,false无权限。 viewPermission Boolean 预览权限;true有权限,false无权限。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 否 String 地址,用于app鉴权
  • 请求示例 列举压缩包内文件目录。 POST /ose/v1/archive/listFile Authorization:Bearer+10f88**********4791e9ff { "containerId": "IAADfsBFCO6WtAtuAe3ab00aac61c45e18b0896269d5efb", "fileId": "FvW8fIQFZmz6Fu-lZ-7pKt6wtJISsW0C-", "pwd": " " }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data data object 列举压缩包目录响应数据 表4 data 参数 参数类型 描述 uncompressedFileList UncompressedFileinfoList object 压缩包内的文件信息列表,包括所有子文件和子目录。 同步时返回 taskKey String 异步任务key taskValue Object 异步时返回 progress Integer 任务进度,进度百分比的值 taskId String 任务ID,异步时返回 表5 UncompressedFileinfoList 参数 参数类型 描述 code String 错误码 name String 文件名 type String 文件类型 1:内容 2:目录 updateAt String 文件修改时间戳,单位:毫秒(ms) fileSize String 文件或文件夹大小,单位:字节(Byte) 状态码:400 表6 响应Body参数 参数 参数类型 描述 code String 错误码 msg String 错误描述
  • 请求参数 表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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 表2 请求Body参数 参数 是否必选 参数类型 描述 containerId 是 String 空间id fileId 是 String 文件id pwd 否 String 压缩包加密明文
  • API概览 云空间服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 部门管理 包括创建、修改、删除、查询部门等部门管理接口。 用户管理 包括新建、修改、删除、查询用户等用户管理接口。 空间管理 包括创建、修改、删除、查询空间等空间管理接口。 群组管理 包括创建用户群组、删除群组等接口。 会话管理 包括初始化创建会话、更新会话、登录登出等会话管理接口。 服务订阅 提供业务控制服务获取管理控制服务的订阅状态的接口。 企业设置 提供设置打包下载时生成的压缩包过期清理时间的接口。 其他接口 提供获取JsSdk。 精细化授权 提供获取用户权限列表、权限批量更新等接口。 权限模板 提供获取创建权限模板、编辑权限模板等接口。 文件审核 提供审核列表查询、批量添加 内容审核 记录等接口。 云解压 提供列举压缩包目录的接口。 批量任务操作 包括创建批量任务、取消批量任务、查询批量操作任务列表等批量任务接口。 任务相关基础操作 包括创建任务、获取任务列表等接口。 获取文件列表 提供获取个人空间文件列表和群组部门空间文件列表的接口。 文件管理 包括获取文件的详细信息、新增文件目录、上传文件、重命名文件等文件管理接口。 文件收藏 包括批量收藏文件、列举收藏文件信息接口。 分享管理-我分享的 包括创建分享、获取分享详情、修改分享等接口。 分享管理-分享给我 包括获取分享详情、退出分享等接口。 分享管理-访问链接 包括获取分享信息、验证分享提取码等接口。 协作门户 包括查询与我有关的文件、查询我最近访问的文件接口。 消息通知 包括查询获取未读消息、消息列表、批量删除消息等接口。
  • 请求参数 表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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权
  • 请求示例 获取空间信息(一个用户可能多个空间,此接口获取空间信息列表) GET /koodrive/ose/v2/space/12156464 Authorization: HMAC-SHA256 AppId=a378331eca141163119eb602adb67b7802cc79cd33ba44c7d2fe61d1586c96a1,SignedHeaders=host;x-date;x-user-id,Signature=bd355f202be40f95bf9510fd7bd48ad711a7d144c01df07d515ee0fbf3a47416 X-User-Id: 1505084218764547200 Host: 10.32.45.165 X-Date: 20240909T033325Z
  • 响应示例 状态码: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 搜索结果 { "files" : [ { "id" : "Fu2A5BQZ1qUk3h1tU6ZlAS66swzlN9mnJ", "sha256" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632", "fileName" : "KooDrive服务介绍.docx", "fileSuffix" : "docx", "fileType" : "26", "size" : "705395", "updateTime" : "2024-12-25T06:41:22.873Z", "idPath" : "DFcz6PEuDwIArootIAAFWbRXM-jxLg8CA1578177668157825025", "downloadLinks" : [ { "usage" : "content", "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e518a982307ef9b6d6e4bd8788e421d3488f58f3ed79eb3ab42702ac5c3d7513" }, { "usage" : "thumbnail", "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=ad55a09e66ddd32c6f9b3cce08c7c9a867c7a579a41200f415fb2918de1ab473" } ], "teamName" : "fdsgdsf", "teamId" : "1578175198769733633", "containerId" : "IAAFWbRXM-jxLg8CA1578177668157825025", "containerType" : "0", "favorite" : false, "owner" : "hid42638091", "ownerId" : "1568722386902108288", "properties" : { "localCreatedAt" : "", "localUpdatedAt" : "", "createUser" : "1568722386902108288", "lastEditUser" : "1568722386902108288", "auditResult" : "{\"auditDetail\":\"{}\",\"auditLevel\":10,\"auditResult\":1}" }, "attachments" : [ { "assetId" : "1584078561541652992", "asset" : { "id" : "1584078561541652992", "versionId" : "1584078561541652993", "version" : 49923, "mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "state" : 0, "createdTime" : "2024-12-25T06:41:20.050Z", "modifiedTime" : "2024-12-25T06:41:20.050Z", "resource" : { "id" : "1584078561810055808", "length" : 705395, "sha256" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632", "object" : { "id" : "18ad967c9af047fd8b909ed163c0fdb6086", "start" : 0, "downloadUrl" : { "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e518a982307ef9b6d6e4bd8788e421d3488f58f3ed79eb3ab42702ac5c3d7513", "method" : "GET" }, "images" : [ { "process" : "image/resize,m_lfit,h_128,w_128", "downloadUrl" : { "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=ad55a09e66ddd32c6f9b3cce08c7c9a867c7a579a41200f415fb2918de1ab473", "method" : "GET" } } ] } }, "attributes" : { "fileName" : "KooDrive服务介绍.docx", "localCreatedAt" : "", "createdBy" : "667706171d1c4ef2a4d7464f3656066c", "resource" : { "id" : "1584078561810055808", "object" : { "bucket" : "b10-obs-ykj-uat-01", "objectId" : "18ad967c9af047fd8b909ed163c0fdb6086" } }, "localUpdatedAt" : "" } }, "versionId" : "1584078561541652993", "attributes" : { "fileName" : "KooDrive服务介绍.docx", "localCreatedAt" : "", "createdBy" : "667706171d1c4ef2a4d7464f3656066c", "resource" : { "id" : "1584078561810055808", "object" : { "bucket" : "b10-obs-ykj-uat-01", "objectId" : "18ad967c9af047fd8b909ed163c0fdb6086" } }, "localUpdatedAt" : "" }, "hash" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632", "length" : 705395, "mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "usage" : "content", "sha256" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632", "createdTime" : "2024-12-25T06:41:20.050Z", "modifiedTime" : "2024-12-25T06:41:20.050Z" } ], "createdTime" : "2024-12-25T06:41:19.794Z", "editedTime" : "2024-12-25T06:41:22.873Z", "lastEditor" : { "category" : "drive#user", "me" : true, "permissionId" : "1570905506917367936", "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS02Njc3MDYxNzFkMWM0ZWYyYTRkNzQ2NGYzNjU2MDY2Yw", "displayName" : "hid42638091" }, "mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "owners" : [ { "category" : "drive#user", "me" : true, "permissionId" : "1570905506917367936", "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS02Njc3MDYxNzFkMWM0ZWYyYTRkNzQ2NGYzNjU2MDY2Yw" } ], "parentFolder" : [ "DFcz6PEuDwIArootIAAFWbRXM-jxLg8CA1578177668157825025" ], "recycled" : false, "userProperties" : { "properties" : { "hidden" : "false" } }, "userCapabilities" : { "addChildNodePermission" : true, "copyPermission" : true, "deletePermission" : true, "downloadPermission" : true, "editPermission" : true, "listChildNodePermission" : true, "removeChildNodePermission" : true, "renameFilePermission" : true, "shareFilePermission" : true, "uploadPermission" : true, "viewPermission" : true } } ], "total" : 1, "code" : 0, "msg" : "成功" }
  • 请求示例 搜索文件请求示例。 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" } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 消息日志跟踪标识(必须58位) 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鉴权 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 searchType 是 String 查询类型 personal:个人空间 team:团队空间 pageInfo 是 pageInfo object 分页信息 filter 否 filter object 过滤器 sortInfo 否 sortInfo object 排序信息 recycled 否 Boolean 是否查询回收站,不传默认false 枚举值: true:查回收站文件 false:查对应空间非回收站 recursived 否 Boolean 是否递归查询子目录文件,默认false imageProcess 否 String 图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 表3 pageInfo 参数 是否必选 参数类型 描述 pageSize 是 Integer 每页大小,取值范围[1,100] pageCursor 是 String 起始游标,为空时从第一页开始查询 表4 filter 参数 是否必选 参数类型 描述 keyWord 否 String 文件名称,模糊匹配,最长80个字符 containerId 否 String 空间id,指定父目录时必传 parentFolder 否 String 父目录 fileType 否 String 文件类型,枚举值 /** * 文件夹 / FOLDER("10"), /* * 智能文件夹(该功能目前只有白名单用户使用) / SMART_FOLDER("11"), /* * 图片 / 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:升序列
  • Token认证 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token目前采取从服务前端登录后,从cookie获取,如图1所示,“Authorization”的Value值即为要获取的AT。 图1 获取Token 获取Token后,再调用其他接口时,您需要在请求消息头中添加“Authorization”,其值即为Token。例如Token值为“ABCDEFG....”,则调用接口时将“Authorization: ABCDEFG....”加到请求消息头即可,如下所示。 POST https://cn.myhuaweicloud-koodrive.com/koodrive/ose/v1/files/batch Content-Type: application/json Authorization: xxx
  • APP鉴权 可通过koodrive提供的app鉴权生成规则来获取鉴权,将鉴权放入请求头中。 示例: Authorization: HMAC-SHA256 AppId=a378331eca141163119eb602adb67b7802cc79cd33ba44c7d2fe61d1586c96a1,SignedHeaders=host;x-date;x-user-id,Signature=bd355f202be40f95bf9510fd7bd48ad711a7d144c01df07d515ee0fbf3a47416 X-User-Id: 1505084218764547200 Host: 10.32.45.165 X-Date: 20240909T033325Z
  • 响应参数 状态码: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
  • 请求参数 表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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权
  • 响应示例 状态码: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" : "成功" }
  • 请求示例 修改部门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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 部门名称 parentId 是 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表示美式英语,不传默认美式英语 X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 表3 请求Body参数 参数 是否必选 参数类型 描述 amendModRoles 是 Array of AmendModRoleDelete objects 删除用户列表 表4 AmendModRoleDelete 参数 是否必选 参数类型 描述 userId 是 Long 用户id
  • 请求示例 批量删除群组369528171409614001中的用户。 POST /koodrive/ose/v1/usergroups/369528171409614001/members/batchDelete Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad { "userIds": ["3432423464657862424","132543141414141414"] }
  • 请求参数 表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} X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 表2 请求Body参数 参数 是否必选 参数类型 描述 tenantId 否 String 租户标识 packageDownloadExpires 是 Integer 打包下载时生成的临时压缩包过期清理时间,默认值7.取值范围[1, 30]
  • URI GET /koodrive/ose/v1/star/files 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每个返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果 pageCursor 否 String 当前页游标,由前一个响应的nextCursor获取 sortType 否 Integer 排序类型,1:收藏时间(默认) sortDirection 否 Integer 排序方向,1:升序,2:降序(默认) fileType 否 String 文件类型: 10:文件夹 11:智能文件夹(该功能目前只有白名单用户使用) 15:图片 20:视频 26:word 27:excel 28:ppt 30:音频 35:压缩文件 40:应用 45:其他 imageProcess 否 String 图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全