删除文件
功能介绍
删除文件
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
DELETE /v4/repositories/{repository_id}/repository/file
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_path |
是 |
String |
参数解释: 文件路径。 取值范围: 字符串长度不少于1,不超过10000。 |
author_name |
否 |
String |
参数解释: 作者名称 取值范围: 1-10000 |
branch |
是 |
String |
参数解释: 分支名称。 取值范围: 字符串长度不少于1,不超过2000。 取值范围: 1-2000 |
commit_message |
是 |
String |
参数解释: 删除描述。 取值范围: 字符串长度不少于1,不超过2000。 取值范围: 1-2000 |
author_email |
否 |
String |
参数解释: 作者邮箱。 取值范围: 字符串长度不少于1,不超过2000。 取值范围: 1-2000 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:204
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 状态码。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
DELETE https://{endpoint}/v4/repositories/2112015538/repository/file?file_path=2112016471&branch=master&commit_message=123
响应示例
状态码:204
OK
{ "status" : "success" }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
204 |
OK |
401 |
Unauthorized |
错误码
请参见错误码。