- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- SSH Key
-
Repository
- 获取分支目录下的文件
- 获取仓库统计数据
- 获取一个仓库下特定分支的图片文件
- 修改被流水线引用的仓库状态
- 判断用户是否有仓库的管理员权限
- 设置仓库是公开状态还是私有状态
- 获取一个仓库下特定分支指定文件内容
- 获取公开示例模板列表
- 创建仓库
- 根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url
- 根据组名和仓库名查询某仓库某分支对应的提交
- 查询某仓库对应的分支
- 根据仓库id查询仓库某分支对应的提交,提供更多可选参数
- 添加部署密钥
- 删除仓库部署密钥
- 获取仓库上一次的提交统计信息
- 仓库统计
- 删除仓库
- 查看仓库的创建状态
- 查询某仓库的标签列表
- 新建标签
- 查询某个仓库的详细信息
- 获取代码提交行数
- 下载仓库
- 新建保护分支
- 删除保护分支
- 批量删除保护分支
- 新建保护tag
- 删除保护tag
- 获取仓库分支列表
- 获取仓库合并请求列表
- 获取仓库合并请求详情
- 获取仓库ip白名单
- 添加仓库ip白名单
- 修改仓库ip白名单
- 删除仓库ip白名单
- 获取合并请求的变化
- 关联仓库与成员组
- 根据仓库短ID锁定仓库
- 根据仓库短ID解锁仓库
- 审核合并请求
- 获取关联工作项信息
- 根据仓库短ID和合并请求短ID获取检视人信息
- 获取变更文件列表
- Tenant
- Group
- V2Project
- RepoMember
- Commit
- File
- User
- Webhook
- Project
- v2仓库管理
- Discussion
- 应用示例
- 附录
- 历史API
-
常见问题
- 认证鉴权问题
- 成员权限问题
-
代码上传下载问题
- 从本地推送代码仓到CodeArts Repo时,报错"Error: Deny by project hooks setting 'default': message of commit"
- 用户推送二进制文件到CodeArts Repo失败
- 执行git push 命令时,报错'origin' does not appear to be a git repository...
- 在CentOS系统下使用HTTPS协议克隆代码时,报错"The requested URL returned error: 401"
- 使用git pull拉取CodeArts Repo的代码失败,报错"Merge branch 'master' of https://test.com Please Enter a commit"
- fatal: refusing to merge unrelated histories
- 如何阻止涉密文件被推送到CodeArts Repo代码仓库
- 仓库迁移问题
- 合并请求问题
- Fork同步问题
- 仓库容量问题
- 常见问题汇总
- 视频帮助
- 计费说明
- 文档下载
- 通用参考
链接复制成功!
创建提交
功能介绍
能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/projects/{repo_id}/repository/commits
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repo_id |
是 |
Integer |
参数解释: 仓库短id 约束限制: 必传 取值范围: 0-2147483647 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
branch |
是 |
String |
参数解释: 目标分支 约束限制: 必传 取值范围: 最小长度:1 最大长度:200 默认取值: 不涉及 |
commit_message |
是 |
String |
参数解释: 提交信息 约束限制: 必传 取值范围: 最小长度:0 最大长度:2000 默认取值: 不涉及 |
start_branch |
否 |
String |
参数解释: 创建分支时,新的分支名 约束限制: 无 取值范围: 最小长度:1 最大长度:200 默认取值: 不涉及 |
actions |
是 |
Array of CommitAction objects |
参数解释: 提交处理列表 约束限制: 无 取值范围: 最小长度:1 最大长度:100 默认取值: 不涉及 |
author_email |
否 |
String |
参数解释: 提交作者的电子邮件地址 |
author_name |
否 |
String |
参数解释: 提交作者的名称 |
stats |
否 |
Boolean |
参数解释: 是否包括提交统计信息。默认值为true |
force |
否 |
Boolean |
参数解释: 是否覆盖目标分支。当true时,使用基于start_branch的新提交覆盖目标分支 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
参数解释: 要执行的操作:create、delete、move、update、chmod 约束限制: 必传 取值范围: create、delete、move、update、chmod 默认取值: 不涉及 |
file_path |
是 |
String |
参数解释: 文件的完整路径。例如lib/class.rb 约束限制: 必传 取值范围: 无 默认取值: 不涉及 |
previous_path |
否 |
String |
参数解释: 要移动的文件的原始完整路径。例如lib/class1.rb。仅在move操作时生效 约束限制: 无 取值范围: 无 默认取值: 不涉及 |
content |
否 |
String |
参数解释: 文件内容,create和update操作时必须。未指定内容的移动操作将保留现有文件内容,内容的任何其他值将覆盖文件内容。 约束限制: 无 取值范围: 无 默认取值: 不涉及 |
encoding |
否 |
String |
参数解释: 文件编码:text、base64。默认为text 约束限制: 无 取值范围: 无 默认取值: 不涉及 |
last_commit_id |
否 |
String |
参数解释: 最后一个已知的提交ID。仅在update、move、delete操作时生效 约束限制: 无 取值范围: 无 默认取值: 不涉及 |
execute_filemode |
否 |
Boolean |
参数解释: 启用或者禁用文件的执行模式。仅在chmod操作时生效 约束限制: 无 取值范围: 无 默认取值: 不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
参数解释: 响应错误码 |
result |
CreateCommitResponseBody object |
参数解释: 响应结果 |
status |
String |
参数解释: 调用此接口的响应状态。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 符合错误码格式字符串,长度[0,100] |
message |
String |
参数解释: 错误信息 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 提交对应的SHA id |
short_id |
String |
参数解释: 提交对应的短SHA id |
title |
String |
参数解释: 提交标题 |
author_name |
String |
参数解释: 作者 |
author_email |
String |
参数解释: 作者邮箱 |
committer_name |
String |
参数解释: 提交作者 |
committer_email |
String |
参数解释: 提交作者邮箱 |
created_at |
String |
参数解释: 创建时间 |
message |
String |
参数解释: 提交信息 |
parent_ids |
Array of strings |
参数解释: 父提交id |
committed_date |
String |
参数解释: 提交时间 |
authored_date |
String |
参数解释: 作者提交时间 |
stats |
stats object |
参数解释: 统计信息 |
请求示例
POST https://{endpoint}/v2/projects/859341/repository/commits { "branch" : "master", "commit_message" : "some commit message", "actions" : [ { "action" : "create", "file_path" : "test001.txt", "content" : "some content" } ] }
响应示例
状态码: 200
OK
{ "result" : { "id" : "85a0a9d5c6e43bc9c3e443ac01f789e24eeef02b", "title" : "some commit message", "message" : "some commit message", "short_id" : "85a0a9d5", "author_name" : "repo", "author_email" : null, "committer_name" : "repo", "committer_email" : null, "created_at" : "2021-09-26T03:44:51.000Z", "parent_ids" : [ "5c114bb316dff4d4a046e09a5c44c816f2433140" ], "committed_date" : "2021-09-26T03:44:51.000Z", "authored_date" : null, "stats" : { "additions" : 1, "deletions" : 0, "total" : 1 } }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。