华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 业务跟踪id language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-Csrf-Token 是 String CS RF Token 表3 请求Body参数 参数 是否必选 参数类型 描述 pageInfo 否 PageInfo object 分页信息 sortInfo 否 FileSortInfo object 分类信息 containerId 是 String 空间标识 parentFileId 是 String 文件父目录,枚举值: root:普通文件系统根目录 sbox:保险箱文件系统根目录 fileType 否 String 文件类型 10:文件夹 15:图片 20:视频 26:word 27:excel 28:ppt 30:音频 35:压缩文件 40:应用 45:其他 表4 PageInfo 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页文件数量,默认100 pageCursor 否 String 分页起始游标 表5 FileSortInfo 参数 是否必选 参数类型 描述 sortType 否 Integer 排序字段 1:文件名排序 2:文件大小排序 3:创建时间排序 4:修改时间排序 5:回收时间(只针对于回收文件) 6:文件格式排序 sortDirection 否 Integer 排序顺序 1:升序 2:降序
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-Csrf-Token 是 String Csrf Token 表2 请求Body参数 参数 是否必选 参数类型 描述 userId 是 String OrgID中的用户标识
  • 请求示例 创建一个用户,关联的orgId中的userId为1008600000029937613。 POST https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/users Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "userId": "1008600000029937613" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-Csrf-Token 是 String Csrf Token
  • 请求示例 删除1319678187126486144部门。 DELETE https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/departments/1319678187126486144 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语
  • 请求示例 查看文件详情。 POST https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/files/FqNZrzGgSKHkfGmwjf7dLgLlGkwrLEU35/detail Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" }
  • 响应示例 状态码: 200 文件详情 { "id" : "FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y", "fileName" : "下载_20231213_160540.png", "mimeType" : "image/png", "fileSuffix" : "png", "recycled" : false, "size" : 81243, "parentFolder" : [ "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" ], "containers" : [ "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" ], "properties" : { "localCreatedAt" : "", "localUpdatedAt" : "", "createUser" : "369528171409614001", "lastEditUser" : "369528171409614001" }, "attachments" : [ { "asset" : { "id" : "1310155787561278720", "versionId" : "1310155787561278721", "version" : 612304, "mimeType" : "image/png", "state" : 0, "createdTime" : "2023-12-13T08:05:40.655Z", "modifiedTime" : "2023-12-13T08:05:40.655Z", "resource" : { "id" : "1275457496273837312", "length" : 81243, "sha256" : "f08b00d63f9109fda252e45cc70e2762347907aba7c5dea4de7eb179ddad1ab2", "object" : { "id" : "b91e8df8afba4145a310dde1bfb9f8c5086", "start" : 0, "downloadUrl" : { "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/b91e8df8afba4145a310dde1bfb9f8c5086?response-content-disposition=attachment%3B%20filename%3D%22%25E4%25B8%258B%25E8%25BD%25BD_20231213_160540.png%22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231227T073619Z&X-Amz-SignedHeaders=host&X-Amz-Expires=10000&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20231227%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=6fc56f74a9478e088e1e044f453c33f8cc7b403f4478d3aefd923449349373e4", "method" : "GET" } } }, "attributes" : { "fileName" : "下载.png", "localCreatedAt" : "", "createdBy" : "40086000004871666", "resource" : { "id" : "1275457496273837312", "object" : { "bucket" : "b10-obs-ykj-uat-01", "objectId" : "b91e8df8afba4145a310dde1bfb9f8c5086" } }, "localUpdatedAt" : "" } }, "hash" : "f08b00d63f9109fda252e45cc70e2762347907aba7c5dea4de7eb179ddad1ab2", "usage" : "content", "sha256" : "f08b00d63f9109fda252e45cc70e2762347907aba7c5dea4de7eb179ddad1ab2" } ], "owners" : [ { "category" : "drive#user", "me" : true, "permissionId" : "1243622029865966464", "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng", "displayName" : "租户管理员" } ], "lastEditor" : { "category" : "drive#user", "me" : true, "permissionId" : "1243622029865966464", "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng", "displayName" : "租户管理员" }, "fileType" : "15", "createdTime" : "2023-12-13T08:05:40.601Z", "editedTime" : "2023-12-13T08:05:41.054Z", "code" : 0, "msg" : "Success." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 业务跟踪id X-Csrf-Token 是 String CSRF Token language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表3 请求Body参数 参数 是否必选 参数类型 描述 containerId 是 String 空间标识
  • 请求示例 查看用户1316083732377070977的相关信息。 GET https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/users/1316083732377070977 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5
  • 响应示例 状态码: 200 用户信息 { "data" : { "id" : "1316083732377070977", "orgId" : "9190086000001210958", "userId" : "1008600000293202821", "deptId" : "1243693141656107521", "deptName" : "newDept", "mobile" : "0086181****8439", "name" : "小二的测试账号", "role" : 1, "status" : 0, "containerId" : "IAADfsBFCO6WtAtuA90eeed43700740089df25f009a8302", "capacity" : 1, "spaceUsed" : 85, "spaceStatus" : "0" }, "code" : 0, "msg" : "success" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-Csrf-Token 是 String Csrf Token
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data userInfo object 用户信息 表4 userInfo 参数 参数类型 描述 name String 名称 userId String 用户Id orgId String 组织标识 deptId String 部门标识 deptName String 部门名称 mobile String 手机号 role Integer 角色 status Integer 状态 containerId String 空间标识 capacity Long 个人空间大小 spaceUsed Long 已用空间大小
  • 请求示例 在IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4空间下的根目录创建文件夹。 POST http://10.34.116.66:8080/koodrive/ose/v1/directory Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "createdTime": "", "editedTime": "", "description": "222", "mimeType": "application/vnd.huawei-apps.folder", "fileName": "ttgg", "fileType": "10", "parentFolder": [ "root" ], "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "renameMode": "2" }
  • 概述 欢迎使用云盘服务(KooDrive)。KooDrive是华为云面向政企等客户推出的数据存储、访问、同步、管理和协作等功能的在线服务,是企业的一站式数字内容中枢,使能企业高效知识协作。 您可以使用本文档提供的API对云盘服务进行相关操作,如新增文件目录、获取文件详情、重命名文件等。支持的全部操作请参见API概览。 在调用KooDrive API之前,请确保已经充分了解KooDrive相关概念,详细信息请参见《产品介绍》。 父主题: 使用前必读
  • 响应示例 状态码: 200 用户列表信息 { "list" : [ { "id" : 1316083732377071000, "userId" : "1008600000293202821", "deptId" : 1243693141656107500, "deptName" : "newDept", "mobile" : "0086181****8439", "name" : "小二的测试账号", "role" : 1, "status" : 0, "containerId" : "IAADfsBFCO6WtAtuA90eeed43700740089df25f009a8302", "capacity" : 1, "spaceUsed" : 85, "spaceStatus" : "0" }, { "id" : 1315783852559526700, "userId" : "1008600000292227464", "deptId" : 1243693141656107500, "deptName" : "newDept", "mobile" : "0086151****8338", "name" : "test123", "role" : 1, "status" : 2 }, { "id" : 1306530710542172000, "userId" : "1008600000183450002", "deptId" : 1243693141656107500, "deptName" : "newDept", "mobile" : "0086133****3333", "name" : "jxccc", "role" : 1, "status" : 2, "containerId" : "IAADfsBFCO6WtAtuA14b73139f1e243f5b8d218f6effaa1", "capacity" : 2, "spaceUsed" : 0, "spaceStatus" : "0" }, { "id" : 1289290865663084500, "userId" : "1008600000104318820", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "myf", "role" : 0, "status" : 0, "containerId" : "IAADfsBFCO6WtAtuAe6851759e8fc4e83bd4569a331fcd2", "capacity" : 2, "spaceUsed" : 0, "spaceStatus" : "0" }, { "id" : 1289265371978729500, "userId" : "1008600000104214631", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "abcd11122", "role" : 0, "status" : 2, "containerId" : "IAADfsBFCO6WtAtuA71d9748f6ae841bf8e76b57240230d", "capacity" : 1, "spaceUsed" : 0, "spaceStatus" : "0" }, { "id" : 1289262603687757800, "userId" : "1008600000104188786", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "deptManager", "role" : 0, "status" : 0 }, { "id" : 1284181028272926000, "userId" : "1008600000085134677", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "lcq001", "role" : 1, "status" : 1, "containerId" : "IAADfsBFCO6WtAtuA4ec1e2bad58f4776b5e97a7839260b", "capacity" : 2, "spaceUsed" : 0, "spaceStatus" : "0" }, { "id" : 1279659436834610700, "userId" : "1008600000072124178", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "liuchuanqi08", "role" : 0, "status" : 0, "containerId" : "IAADfsBFCO6WtAtuA96a40fcefba648bfad2c9a74f9d35b", "capacity" : 13, "spaceUsed" : 0, "spaceStatus" : "0" }, { "id" : 1278097563530090800, "userId" : "1008600000063695737", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "newDeptManager1", "role" : 0, "status" : 0, "containerId" : "IAADfsBFCO6WtAtuA2ad3f7b1320c43a3ba2934ef17232c", "capacity" : 2, "spaceUsed" : 0, "spaceStatus" : "0" }, { "id" : 1270854289148921000, "userId" : "1008600000037631076", "deptId" : 1243693141656107500, "deptName" : "newDept", "name" : "wsl普通用户", "role" : 1, "status" : 0, "containerId" : "IAADfsBFCO6WtAtuAa2db5dea659c41139b81b106593233", "capacity" : 6, "spaceUsed" : 1, "spaceStatus" : "0" } ], "total" : 13, "code" : 0, "msg" : "success" }
  • 请求示例 查询部门1243693141656107521下用户列表,从0开始查询10个用户。 GET https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/userList?deptId=1243693141656107521&offset=0&limit=10 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5
  • URI GET /koodrive/ose/v1/userList 表1 Query参数 参数 是否必选 参数类型 描述 deptId 否 String 部门标识 isDirect 否 Boolean 是否为直属用户,默认为false offset 是 String 偏移量,最小值为0 limit 是 String 最大返回个数。最小值为1,最大值为100 keyWord 否 String 搜索的关键字,可用name作为关键字搜索条件 spaceStatus 否 Integer 空间状态 0:正常 1:禁用 2:未启用 hasSpace 否 Boolean 是否开通了空间
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-Csrf-Token 是 String Csrf Token
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data Array of userInfo objects 用户信息 表4 userInfo 参数 参数类型 描述 name String 名称 userId String 用户Id orgId String 组织标识 deptId String 部门标识 deptName String 部门名称 mobile String 手机号 role Integer 角色 status Integer 状态 containerId String 空间标识 capacity Long 个人空间大小 spaceUsed Long 已用空间大小
  • 响应示例 状态码: 200 服务状态 { "data" : { "tenantId" : "40086000004871666", "status" : 0, "spaceCapacity" : 10000, "userCount" : 7000, "personalSpaceSize" : 0, "groupSpaceSize" : 10, "organizationName" : "KooDrive-不要删", "organizationId" : "9190086000001210958", "rootDeptCode" : "aed8a3763f9b4177beb2dd8bce1a3885", "aiAvailable" : true }, "code" : 0, "msg" : "成功" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data ServiceStatus object 云服务订购状态 表4 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 租户标识
  • 请求示例 取消一个批量任务。 POST /koodrive/ose/v1/cancel Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5 { "jobId":"1289250105886769024" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 X-Csrf-Token 是 String CSRF Token language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 jobId 是 String 任务ID
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 data String 操作结果 状态码: 400 表4 响应Header参数 参数 参数类型 描述 X-request-id String 任务跟踪的请求ID号 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 业务跟踪id X-Csrf-Token 是 String CSRF Token language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语
  • 响应示例 状态码: 200 全路径信息 { "fileIdPath" : "/DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4/FkbdCAceMj89bprz5xLJASID1eaRqjlRP/FqIAmBlIz7ovbThxeUBlOpbnCHaP_MTUL/FqS6hLLy_DkjlWdfOnEdCErhsmokRvdXI", "namePath" : "/rootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4/007/001/批量任务测试", "code" : 0, "msg" : "成功" }
  • 请求示例 查询文件的完整目录路径。 https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/cloudfile/v1/files/path?fileId=FqS6hLLy_DkjlWdfOnEdCErhsmokRvdXI&containerId=IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5
  • 请求示例 删除用户1244780780316557312及对应的资源。 DELETE https://kdconsole-daily.hwcloudtest.cn:8080/koodrive/ose/v1/users/1244780780316557312 Authorization:Bearer+10f88d07fa3b86e520ab75eef417574840f15a544791e9ff X-Csrf-Token:fc41ff2190ff0d6a6a08ed12718274d8f0d9330a8ce439a5
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 x-trace-id 否 String 消息日志跟踪标识 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 X-Csrf-Token 是 String Csrf Token
共100000条