更新时间:2026-02-03 GMT+08:00

重命名文件 - renameFile

功能介绍

重命名文件。

授权信息

当前API调用无需身份策略权限。

URI

POST /koodrive/ose/v1/files/rename/{fileId}

表1 路径参数

参数

是否必选

参数类型

描述

fileId

String

参数解释:

文件ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token}

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

X-Traceid

String

参数解释:

业务跟踪id(必须58位)

约束限制:

不涉及

取值范围:

长度为58位

默认值:

不涉及

language

String

参数解释:

国际化语言标识

约束限制:

符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语

取值范围:

符合i18n规范

默认取值:

en-US

X-User-Id

String

参数解释:

KooDrive侧用户id,用于app鉴权

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

X-Date

String

参数解释:

日期,用于app鉴权,格式为yyyyMMdd‘T’HHmmss‘Z’

约束限制:

距当前时间15分钟以内,不能晚于当前时间

取值范围:

不涉及

默认值:

不涉及

x-hw-share-folder-id

String

参数解释:

共享文件夹ID。如果传入了该请求头,则说明当前的操作是在共享文件夹内。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

containerId

String

参数解释:

空间标识

约束限制:

长度限制64

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

文件新名称

约束限制:

不能包含'<>|:"*?/\',不能等于..或.,最长250个字符

取值范围:

不涉及

默认取值:

不涉及

renameMode

Integer

参数解释:

重名策略

约束限制:

不涉及

取值范围:

  • 2#强制重命名,出现重名文件时,文件名末尾追加时间戳 - 3#拒绝重命名,出现重名文件时,创建失败

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

返回码

msg

String

返回消息

请求示例

将空间标识为IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 空间下,文件id为FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y的文件重命名为“下载”。

POST /koodrive/ose/v1/files/rename/FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y

Authorization:Bearer+10f88*********4791e9ff

{
    "name": "下载",
    "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "renameMode": 2
}

响应示例

状态码:200

重命名完成返回的信息

{
  "code" : 0,
  "msg" : "success"
}

状态码

状态码

描述

200

重命名完成返回的信息