华为云用户手册

  • 响应示例 状态码: 200 群组列表信息。 { "total" : 2, "userGroupList" : [ { "id" : "1407237551361847809", "groupName" : "7", "ownerId" : "1395476983395324033", "createdTime" : "2024-04-25T06:49:49.000Z", "updatedTime" : "2024-04-25T06:49:49.000Z" }, { "id" : "1404926806536180481", "groupName" : "111", "ownerId" : "1395476983395324033", "createdTime" : "2024-04-22T02:18:46.000Z", "updatedTime" : "2024-04-22T02:18:46.000Z" } ], "code" : 0, "msg" : "成功" }
  • URI GET /koodrive/ose/v1/usergroups 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 是 Integer 每个返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果 pageCursor 是 String 当前页游标,由前一个响应的nextCursor获取 groupName 否 String 用户组名 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表示美式英语,不传默认美式英语
  • 请求示例 更新部门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表示美式英语,不传默认美式英语
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取 2. 此处应用为KooDrive服务端 X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh_cn表示简体中文,en_us表示美式英语
  • 响应示例 状态码: 200 用户空间列表信息 { "total" : 1, "users" : [ { "tenantId" : "cad444830661464d9da88784a96d960c", "status" : 0, "capacity" : 10, "spaceUsed" : 189, "containerId" : "IAAE49hOR8LulgAAA1410765425310141185", "id" : "1410765364786334592", "role" : 1, "name" : "xx", "deptName" : "xxx", "userId" : "1008600000445114904", "deptId" : 1410183811475666000, "mobile" : "0086147****6900", "spaceStatus" : "0" } ], "code" : 0, "msg" : "成功" }
  • URI GET /koodrive/ose/v1/space/userList 表1 Query参数 参数 是否必选 参数类型 描述 deptId 否 String 部门标识。当未传值时,系统管理员用户查询当前组织下的用户空间列表,部门管理员用户查询所在部门的用户空间列表 isDirect 否 Boolean 是否为直属用户,默认为false offset 是 String 偏移量,最小值为0 limit 是 String 最大返回个数。最小值为1,最大值为100 keyWord 否 String 搜索的关键字,可用name和mobile作为关键字搜索条件。 spaceStatus 否 String 空间状态
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 users Array of userSpaceInfo objects 用户空间信息 total String 总数 表4 userSpaceInfo 参数 参数类型 描述 name String 用户名称 deptId String 部门标识 deptName String 部门名称 mobile String 手机号 role Integer 用户角色 status Integer 用户账号状态 containerId String 空间标识 capacity Long 个人空间大小 spaceUsed Long 已用空间大小 tenantId String 租户id id String 用户空间id userId String 用户id spaceStatus String 空间状态
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 msg String 错误信息 total String 总数 teams Array of TeamSpaceInfo objects 团队空间信息列表 表4 TeamSpaceInfo 参数 参数类型 描述 id String 空间所属的部门ID、用户组ID或群组ID groupName String 团队空间名称,为部门名称或用户组名称 status Integer 空间状态 capacity Integer 空间大小 spaceUsed String 已用空间大小 containerId String 云空间标识 userNum Integer 用户数 ownerId String 拥有者ID ownerName String 拥有者名称 tenantId String 租户标识 creator String 创建者 createTime String 创建时间 modifier String 修改状态 updateTime String 更新时间 bizRootFileId String 云空间根目录id bizSboxFileId String 云空间保险箱目录id iconUrl String 图标链接 top Integer 置顶 role Integer 角色 deptNamePath String 部门所在位置
  • 响应示例 状态码: 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" : "成功" }
  • 请求参数 表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 群组空间列表信息。 { "total": 1, "groupsTotal": 1, "groupsMax": 500, "assignedCapacity": 100, "maxCapacity": 2048, "groups": [ { "tenantId": "cad444830661464d9da88784a96d960c", "creator": "1410172329509745795", "createTime": "2024-05-10T01:46:22.000Z", "modifier": "1410172329509745795", "updateTime": "2024-05-10T02:27:23.000Z", "ownerId": "1410172329509745795", "status": 0, "capacity": 20, "spaceUsed": 0, "containerId": "IAAE49hOR8LulgAAA1417956457328121729", "bizRootFileId": "DE5Hwu6WAAAArootIAAE49hOR8LulgAAA1417956457328121729", "bizSboxFileId": "DE5Hwu6WAAAAsboxIAAE49hOR8LulgAAA1417956457328121729", "id": "1417956457311344513", "groupName": "api01", "iconUrl": "1", "ownerName": "hid99522477", "userNum": 1 }, "code" : 0, "msg" : "成功" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 msg String 错误信息 total Integer 总数 groupsTotal Integer 群组总数 groupsMax Integer 最大群组数 assignedCapacity String 已分配容量 maxCapacity String 最大容量 groups Array of TeamSpaceInfo objects 群组空间信息 表4 TeamSpaceInfo 参数 参数类型 描述 id String 空间所属的部门ID、用户组ID或群组ID groupName String 团队空间名称,为部门名称或用户组名称 status Integer 空间状态 capacity Integer 空间大小 spaceUsed String 已用空间大小 containerId String 云空间标识 userNum Integer 用户数 ownerId String 拥有者ID ownerName String 拥有者名称 tenantId String 租户标识 creator String 创建者 createTime String 创建时间 modifier String 修改状态 updateTime String 更新时间 bizRootFileId String 云空间根目录id bizSboxFileId String 云空间保险箱目录id iconUrl String 图标链接 top Integer 置顶 role Integer 角色 deptNamePath 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表示美式英语,不传默认美式英语
  • 请求参数 表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 空间名称 userIds 否 Array of strings 团队成员 iconUrl 否 String 空间头像 capacity 否 Integer 空间大小
  • 响应参数 状态码: 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-hw-trace-id 否 String 消息日志跟踪标识(必须58位) 表2 请求Body参数 参数 是否必选 参数类型 描述 starred 是 Boolean 是否收藏 subRequestList 是 Array of StarFileRequest objects 批量收藏文件列表 表3 StarFileRequest 参数 是否必选 参数类型 描述 containerId 是 String 空间id fileId 是 String 文件id,不允许重复
  • 请求示例 批量删除群组369528171409614001中的用户。 POST /koodrive/ose/v1/usergroups/369528171409614001/members/batchDelete Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad { "userIds": ["3432423464657862424","132543141414141414"] }
  • 请求参数 表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列表
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 status Integer 响应状态,0:全部成功;1:部分成功;2:全部失败 subResponseList Array of MemberResponse objects 子响应列表 表5 MemberResponse 参数 参数类型 描述 code String 响应码 message String 响应码 userId String 成员用户id
  • 响应示例 状态码: 200 查询服务使用量响应 { "data" : { "spaceUsed" : 7753298, "spaceCapacity" : 10240, "deptSpaceQuota" : 6144, "personalSpaceQuota" : 2048, "groupSpaceQuota" : 2048, "reservedSpaceQuota" : 0, "spaceQuotaUsed" : 327, "deptSpaceUsed" : 1975057, "deptSpaceQuotaUsed" : 42, "personalSpaceUsed" : 3933426, "personalSpaceQuotaUsed" : 35, "groupSpaceUsed" : 1844815, "groupSpaceQuotaUsed" : 250, "userCount" : 20, "userMaxCount" : 100, "packageDownloadExpires" : 7, "productType" : "1" }, "code" : 0, "msg" : "success" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应消息 data data object 表3 data 参数 参数类型 描述 spaceQuotaUsed String 云空间配额使用量 userCount String OrgID已建用户数 spaceCapacity String 租户订购空间总容量;单位:GB userMaxCount String 租户订购的最大使用人数 spaceUsed String 空间使用量 deptSpaceQuota String 部门空间配额 personalSpaceQuota String 个人空间配额 groupSpaceQuota String 群组空间配额 reservedSpaceQuota String 保留的空间配额 deptSpaceUsed String 部门空间使用量 deptSpaceQuotaUsed String 部门空间配额使用量 personalSpaceUsed String 个人空间使用量 personalSpaceQuotaUsed String 个人空间配额使用量 groupSpaceUsed String 群组空间使用量 groupSpaceQuotaUsed String 群组空间配额使用量 packageDownloadExpires String 打包下载过期时间 productType String 产品类型
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh_cn表示简体中文,en_us表示美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 tenantId 否 String 租户标识 packageDownloadExpires 是 Integer 打包下载时生成的临时压缩包过期清理时间,默认值7.取值范围[1, 30]
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} x-hw-trace-id 否 String 消息日志跟踪标识(必须58位)
  • URI GET /koodrive/ose/v1/star/files 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每个返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果 最大值:100 pageCursor 否 String 当前页游标,由前一个响应的nextCursor获取 sortType 否 Integer 排序类型,1:收藏时间(默认) sortDirection 否 Integer 排序方向,1:升序,2:降序(默认) fileType 否 String 文件类型: 10:文件夹 15:图片 20:视频 26:word 27:excel 28:ppt 30:音频 35:压缩文件 40:应用 45:其他
  • 请求参数 表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 用户列表
  • 请求示例 批量向群组369528171409614001添加用户。 POST /koodrive/ose/v1/usergroups/369528171409614001/members/batchAdd Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad { "userIds": ["3432423464657862424","132543141414141414"] }
  • KV限制 对于文档类型的KV,包含所有的本地二级索引,key和value之和最大为512KB。 字段名称长度范围为1-63个字节,大小写敏感,不支持“.”和“$”。“X”字符为前缀的字段名称为系统预留字段名称,目前系统预留字段名称包括“Xattr”和“Xblob”,不建议您使用作为字段名。 对于主键,包含所有的本地二级索引,总长不超过1024个字节,且主键必须唯一。 使用API请求方式访问的KV,只能属于一个存储仓。 一个KV一定归属于某个表。 仓+表+Key可以唯一定位KV。
共100000条