- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
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同步问题
- 仓库容量问题
- 常见问题汇总
- 视频帮助
- 计费说明
- 文档下载
- 通用参考
链接复制成功!
API概览
SSH KEY
接口 |
说明 |
---|---|
获取ssh key列表。 |
|
添加ssh key。 |
|
检验私钥是否有拉取代码的权限。 |
Repository
接口 |
说明 |
---|---|
获取分支目录下的文件。 |
|
获取仓库统计数据。 |
|
获取一个仓库下特定分支的图片文件。 |
|
修改被流水线引用的仓库状态。 |
|
判断用户是否有仓库的管理员权限。 |
|
设置仓库是公开状态还是私有状态。 |
|
获取一个仓库下特定分支指定文件内容。 |
|
获取公开示例模板列表。 |
|
用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目。 |
|
获取仓库短id,用于获取仓库详情页面url。 |
|
根据仓库组名、仓库名和分支获取提交列表。 |
|
根据仓库id获取指定仓库的分支列表。 |
|
根据仓库id查询仓库某分支对应的提交。 |
|
添加部署密钥。 |
|
删除仓库部署密钥。 |
|
获取仓库上一次的提交统计信息。 |
|
根据仓库短id,查询仓库的代码提交记录统计。 |
|
根据仓库32位uuid删除指定的仓库。 |
|
获取仓库状态。 |
|
查询指定仓库对应的分支。 |
|
新建标签。 |
|
根据仓库UUID获取仓库信息仓库信息。返回 包含id,name,组名,仓库访问URL。 |
|
获取指定日期内代码仓指定分支的代码提交行数。 |
|
按照指定格式下载仓库。 |
|
新建保护分支。 |
|
获取仓库分支列表。 |
|
获取仓库合并请求列表。 |
|
获取仓库合并请求详情。 |
V2Project
接口 |
说明 |
---|---|
获取用户的所有仓库信息。 |
|
创建项目后,创建仓库组由后台生成方式 传入参数:仓库名、模板id、是否导入项目成员、归属项目。 |
|
创建仓库后fork仓库 传入参数:仓库名、是否导入项目成员、归属项目。 |
|
获取仓库列表,模糊查询支持范围,如果未传入project uuid,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。 |
|
分支关联工作项。 |
RepoMember
接口 |
说明 |
---|---|
获取仓库成员列表,可通过关键字搜索某成员。 |
|
调用方codehubportal,添加仓库成员。 |
|
给仓库中成员设置仓库的操作权限。 |
|
删除仓库成员。 |
Commit
接口 |
说明 |
---|---|
根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。 |
|
能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。 |
|
获取由commit id或分支或标记的名称标识的特定提交。 |
|
根据commit id查询提交差异信息。 |
File
接口 |
说明 |
---|---|
获取仓库中文件的信息,如名称、大小、内容。请注意,文件内容是Base64编码的。 |
User
接口 |
说明 |
---|---|
判断用户使用 https 上传/下载代码时输入的用户名和密码是否合法。 |
WebHook
接口 |
说明 |
---|---|
获取仓库webhook。 |
|
提交代码自动触发编译构建,添加仓库钩子。 |
|
提交代码自动触发编译构建,删除仓库钩子。 |
Project
接口 |
说明 |
---|---|
获取一个项目下可以设置为公开状态的仓库列表。 |
|
一般创建仓库时调用。通过传入项目uuid,仓库名,调用CoudeHubAdapter接口,查询数据库来判断仓库是否重名。 |
v2仓库管理
接口 |
说明 |
---|---|
根据仓库id在指定仓库中创建分支。 |