文件重命名
功能介绍
文件重命名
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v4/repositories/{repository_id}/repository/rename-file
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
file_path |
是 |
String |
参数解释: 文件路径 取值范围: 不涉及。 |
|
branch_name |
是 |
String |
参数解释: 分支名 取值范围: 不涉及。 |
|
commit_message |
是 |
String |
参数解释: 提交信息 取值范围: 不涉及。 |
|
start_branch |
否 |
String |
参数解释: 基于分支名(即基于某分支,向其他分支进行推送) 取值范围: 不涉及。 |
|
author_email |
否 |
String |
参数解释: 作者邮箱 取值范围: 不涉及。 |
|
author_name |
否 |
String |
参数解释: 作者名称 取值范围: 不涉及。 |
|
previous_path |
是 |
String |
参数解释: 改名前地址 取值范围: 不涉及。 |
|
infer_content |
否 |
Boolean |
参数解释: 是否迁移内容(与content字段不能同时为空) 取值范围: 不涉及。 |
|
content |
否 |
String |
参数解释: 文件内容(与infer_content字段不能同时为空) 取值范围: 不涉及。 |
|
encoding |
否 |
String |
参数解释: 编码方式。 取值范围:
默认取值: text |
|
last_commit_id |
否 |
String |
参数解释: 上次已知的文件提交ID。 取值范围: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
file_path |
String |
文件路径 |
|
branch |
String |
分支名称 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
请求示例
无
响应示例
状态码:200
重命名成功
{
"branch" : "master",
"file_path" : "123"
}
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码:403
Bad Request
{
"error_code" : "CH.004403",
"error_msg" : "您没有操作权限,请升级权限后重试。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
重命名成功 |
|
401 |
Unauthorized |
|
403 |
Bad Request |
错误码
请参见错误码。