华为云用户手册

续费相关的功能 包年/包月云空间服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 包年/包月云空间服务从购买到被自动删除之前，您可以随时在KooDrive控制台为云服务器续费，以延长云空间服务的使用时间。 自动续费 开通自动续费后，云空间服务会在每次到期前自动续费，避免因忘记手动续费而导致资源被自动删除。 在一台包年/包月云服务器生命周期的不同阶段，您可以根据需要选择一种方式进行续费，具体如图1所示。 图1 云空间服务生命周期 云空间服务从购买到到期前，处于正常运行阶段，资源状态为“运行中”。 到期后，资源状态变为“已过期”。 到期未续费时，云空间服务首先会进入宽限期，宽限期到期后仍未续费，资源状态变为“已冻结”。 超过宽限期仍未续费将进入保留期，如果保留期内仍未续费，资源将被自动删除。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 在云空间服务到期前均可开通自动续费，到期前7日凌晨3:00首次尝试自动续费，如果扣款失败，每天凌晨3:00尝试一次，直至云空间服务到期或者续费成功。到期前7日自动续费扣款是系统默认配置，您也可以根据需要修改此扣款日。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 taskInfo TaskInfo object 异步任务信息 表4 TaskInfo 参数 参数类型 描述 userId String 用户id taskId String 任务id taskType Integer 任务类型 taskStatus Integer 任务状态，0：待处理，1：处理中，2：已完成，3：已取消 taskResultCode Integer 任务处理结果，1：全部成功，2：部分失败，3：全部失败 resultCode Integer 任务内容处理结果 createTime String 任务创建时间，格式为14位时间戳yyyyMMddHHmmss startTime String 任务开始时间，格式为14位时间戳yyyyMMddHHmmss endTime String 任务结束时间，格式为14位时间戳yyyyMMddHHmmss progress Integer 任务进度，进度百分比的值，如进度为70%时，返回的值是70 downloadUrl String 压缩包下载链接

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "taskInfo" : { "userId" : "string", "taskId" : "string", "taskType" : 0, "taskStatus" : 0, "taskResultCode" : 0, "resultCode" : 0, "createTime" : "string", "startTime" : "string", "endTime" : "string", "progress" : 0, "downloadUrl" : "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参数 参数 是否必选 参数类型 描述 taskId 是 String 任务ID shareId 是 String 分享id kdstoken 否 String token

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标，如果不存在，代表已返回最后一个 relatedToMeInfos Array of RelatedToMeRecord objects 分享链接列表 total Long 总数 表4 RelatedToMeRecord 参数 参数类型 描述 operator String 操作员名称 operateType Integer 操作类型；1：分享 operateTime String 操作时间 id String 记录id，操作类型为分享则是分享id displayName String 展示名称 files Array of FileInfo objects expireTime String 失效时间 status Integer 0：根据失效时间判断；1：文件已被删除，2：空间已失效（空间已禁用删除或者当前用户无空间权限） operatorId String 操作员id containerId String 空间id tenantId String 租户id 表5 FileInfo 参数 参数类型 描述 id String 文件id size String 文件大小 fileType String 文件类型 downloadLinks Array of DownloadLink objects 图片类型需要，图片类型 fileType为15 recycled Boolean 是否在回收站 表6 DownloadLink 参数 参数类型 描述 usage String 用途默认：'content'-实体内容、'thumbnail'-缩略图,业务可以扩展改字段 downloadLink String 附件下载地址

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "relatedToMeInfos" : [ { "operator" : "string", "operateType" : 0, "operateTime" : "2024-06-03T02:25:41.085Z", "id" : "string", "displayName" : "string", "files" : [ { "id" : "string", "size" : "string", "fileType" : "string", "downloadLinks" : [ { "usage" : "string", "downloadLink" : "string" } ], "recycled" : true } ], "expireTime" : "2024-06-03T02:25:41.085Z", "status" : 0, "operatorId" : "string", "containerId" : "string", "tenantId" : "string" } ], "total" : 0 }

请求示例 查询与我有关的文件列表。 GET /koodrive/ose/v1/related?sortType=1&sortDirection=2&pageSize=2&pageCursor=&displayName=&relatedType=1 { "total" : 1, "relatedToMeInfos" : [ { "id" : "1427677119873431808", "operator" : "zujian1", "operatorId" : "1395664261493231745", "operateType" : 1, "operateTime" : "2024-05-23T11:39:35.000Z", "displayName" : "内容未审核.docx", "files" : [ { "id" : "Fv54zG8ha44HX2XRlrQlM76zD4KAN2uOB", "size" : 50383, "fileType" : "26", "recycled" : false, "downloadLinks" : [ { "usage" : "content", "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/6957916206ce4407ac9436567b14d719086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%2586%2585%25E5%25AE%25B9%25E6%259C%25AA%25E5%25AE%25A1%25E6%25A0%25B8.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240523T113937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240523%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e130a202a80157e63583bd7597452eb1d30a70c610db86be68717541114e2bd0" }, { "usage" : "thumbnail", "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/6957916206ce4407ac9436567b14d719086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%2586%2585%25E5%25AE%25B9%25E6%259C%25AA%25E5%25AE%25A1%25E6%25A0%25B8.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240523T113937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240523%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e78515818612dbb024bf14300bd63bbb340e7f7476b988143089ce6d92d6d9f9" } ] } ], "expireTime" : "2024-05-30T11:39:35.000Z", "status" : 0, "containerId" : "IAAFfyRNd07vFgAAA1395504262720721025", "tenantId" : "d5ac574bd2934a69baa4f23c55daa8d4" } ], "code" : 0, "msg" : "成功" }

请求参数 表2 请求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表示美式英语，不传默认美式英语

URI GET /koodrive/ose/v1/related 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 最大值：100 pageCursor 否 String 当前页游标，由前一个响应的nextCursor获取 sortType 否 Integer 排序类型，1：相关操作时间（默认） sortDirection 否 Integer 排序方向，1：升序，2：降序（默认） displayName 否 String 支持按照展示名称模糊匹配 relatedType 否 String 相关类型 0：所有 1、分享给我的，空和0表示查所有类型

请求参数 表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 响应信息 link CommonShareLink object 访问链接公共信息 表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 下载权限

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "link" : { "shareId" : "string", "shortUrl" : "string", "shareTime" : "2024-06-03T02:20:24.274Z", "ownerId" : "string", "ownerName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:20:24.274Z", "status" : 0 } }

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T01:58:35.419Z", "scope" : 0, "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "extractCode" : "string", "expireTime" : "2024-06-03T01:58:35.419Z", "status" : 0, "comment" : "string", "viewCnt" : 0, "downloadCnt" : 0, "saveCnt" : 0, "containerId" : "string", "containerName" : "string" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）

URI GET /koodrive/ose/v1/share 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 最大值：100 pageCursor 否 String 当前页游标，由前一个响应的nextCursor获取 sortType 否 Integer 排序类型，4：分享时间（默认） sortDirection 否 Integer 排序方向，1：升序，2：降序（默认） displayName 否 String 支持按照展示名称模糊匹配

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标，如果不存在，代表已返回最后一个 shareLinks Array of ShareByMeLink objects 分享链接列表 表4 ShareByMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 分享范围，1：收到连接的所有用户，2：仅企业内用户可访问，3：指定企业用户访问 files Array of ShareFileInfo objects 分享的文件列表 displayName String 展示名称 permission SharePermission object 分享权限（后续支持） extractCode String 提取码 expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 comment String 分享留言 viewCnt Integer 浏览次数 downloadCnt Integer 下载次数（后续支持） saveCnt Integer 转存次数（后续支持） containerId String 分享文件所属空间id containerName 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 下载权限

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "string", "ownerId" : "string", "ownerName" : "string", "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:18:51.520Z", "status" : 0, "comment" : "string" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink ShareWithMeLinkDetail object 分享给我的链接信息 表4 ShareWithMeLinkDetail 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 displayName String 展示名称 permission SharePermission object 分享权限（后续支持） expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 comment String 分享留言 表5 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 分享shortUrl extractCode 是 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参数 参数 是否必选 参数类型 描述 scope 是 Integer 分享范围，1：收到连接的所有用户，2：仅企业内用户可访问，3：指定企业用户访问 deptIds 否 Array of strings 部门id列表 groupIds 否 Array of strings 用户组id列表 userIds 否 Array of strings 用户id列表 fileIds 是 Array of strings 文件id列表 containerId 是 String 空间id permission 否 SharePermission object 分享权限（后续支持） extractCode 否 String 提取码 expireTime 否 String 失效时间 comment 否 String 分享留言 validDays 是 Integer 有效分享天数（1-365） 表3 SharePermission 参数 是否必选 参数类型 描述 preview 否 Boolean 预览权限 edit 否 Boolean 编辑权限 download 否 Boolean 下载权限

请求示例 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 错误位置

响应示例 状态码： 200 OK { "data" : { "taskId" : "1428103989525998336" }, "code" : 0, "msg" : "成功" } 状态码： 400 { "error" : { "errorData" : { "conflictFileId" : "string" }, "errorDetail" : [ { "domain" : "string", "reason" : "string", "errorCode" : "string", "description" : "string", "errorPos" : "string", "errorParam" : "string" } ], "code" : 0, "description" : "string" } }

请求示例 列举压缩包内文件目录。 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 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

请求参数 表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 压缩包加密明文

请求参数 表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 子响应信息