CLI命令参考(V3)
SSHKey
Repository
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取分支目录下的文件 | hcloud CodeArtsRepo ListSubfiles/v3 | 获取分支目录下的文件。 | |
| 获取仓库统计数据 | hcloud CodeArtsRepo ShowStatisticalData/v3 | 获取仓库统计数据。 | |
| 获取一个仓库下特定分支的图片文件 | hcloud CodeArtsRepo ShowImageBlob/v3 | 获取一个仓库下特定分支的图片文件。 | |
| 修改被流水线引用的仓库状态 | hcloud CodeArtsRepo ShowHasPipeline/v3 | 修改被流水线引用的仓库状态。 | |
| 根据仓库短ID和合并请求短ID获取检视人信息 | hcloud CodeArtsRepo ListMergeRequestReviewers/v3 | 根据仓库短ID和合并请求短ID获取检视人信息。 | |
| 合并请求代码审核 | hcloud CodeArtsRepo UpdateMergeRequestApprovalState/v3 | 合并请求代码审核。 | |
| 获取变更文件 | hcloud CodeArtsRepo ListMergeChanges/v3 | 获取变更文件。 | |
| 获取关联工作项信息 | hcloud CodeArtsRepo ListRelatedCommits/v3 | 获取关联工作项信息。 | |
| 获取变更文件列表 | hcloud CodeArtsRepo ListMergeChangesTrees/v3 | 获取变更文件列表。 | |
| 判断用户是否有仓库的管理员权限 | hcloud CodeArtsRepo ShowMaster/v3 | 判断用户是否有仓库的管理员权限。 | |
| 设置仓库是公开状态还是私有状态 | hcloud CodeArtsRepo ShareTemplates/v3 | 设置仓库是公开状态还是私有状态。 | |
| 设置仓库是公开状态还是私有状态 | hcloud CodeArtsRepo ListTemplatesTwo/v3 | 设置仓库是公开状态还是私有状态。 | |
| 获取一个仓库下特定分支指定文件内容 | hcloud CodeArtsRepo ListFiles/v3 | 获取一个仓库下特定分支指定文件内容。 | |
| 获取公开示例模板列表 | hcloud CodeArtsRepo GetTemplates/v3 | 获取公开示例模板列表。 | |
| 获取公开示例模板列表 | hcloud CodeArtsRepo ListTwoTemplates/v3 | 获取公开示例模板列表。 | |
| 创建仓库 | hcloud CodeArtsRepo CreateRepository/v3 | 用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目。 | |
| 根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url | hcloud CodeArtsRepo ShowRepoId/v3 | 获取仓库短id,用于获取仓库详情页面url。 | |
| 根据组名和仓库名查询某仓库某分支对应的提交 | hcloud CodeArtsRepo ShowCommitsByBranch/v3 | 根据仓库组名、仓库名和分支获取提交列表。 | |
| 查询某仓库对应的分支 | hcloud CodeArtsRepo ShowBranchesByRepositoryId/v3 | 根据仓库id获取指定仓库的分支列表。 | |
| 根据仓库id查询仓库某分支对应的提交,提供更多可选参数 | hcloud CodeArtsRepo ShowCommitsByRepoId/v3 | 根据仓库id查询仓库某分支对应的提交。 | |
| 添加部署密钥 | hcloud CodeArtsRepo AddDeployKey/v3 | 添加部署密钥。 | |
| 添加部署密钥 | hcloud CodeArtsRepo AddDeployKeyV2/v3 | 添加部署密钥。 | |
| 删除仓库部署密钥 | hcloud CodeArtsRepo DeleteDeployKey/v3 | 删除仓库部署密钥。 | |
| 删除仓库部署密钥 | hcloud CodeArtsRepo DeleteDeployKeyV2/v3 | 删除仓库部署密钥。 | |
| 获取仓库上一次的提交统计信息 | hcloud CodeArtsRepo ListCommitStatistics/v3 | 获取仓库上一次的提交统计信息。 | |
| 仓库统计 | hcloud CodeArtsRepo ShowRepositoryStatistics/v3 | 根据仓库短id,查询仓库的代码提交记录统计。 | |
| 查询项目下的某个仓库 | hcloud CodeArtsRepo GetRepositoryByProjectId/v3 | 不建议再使用,建议使用/{repository_uuid}/status。 | |
| 删除仓库 | hcloud CodeArtsRepo DeleteRepository/v3 | 根据仓库32位uuid删除指定的仓库。 | |
| 查看仓库的创建状态 | hcloud CodeArtsRepo ListRepositoryStatus/v3 | 获取仓库状态。 | |
| 查询某仓库的标签列表 | hcloud CodeArtsRepo ShowBranchesByTwoRepositoryId/v3 | 查询指定仓库对应的分支。 | |
| 新建标签 | hcloud CodeArtsRepo AddTagV2/v3 | 新建标签。 | |
| 查询某个仓库的详细信息 | hcloud CodeArtsRepo ShowRepositoryByUuid/v3 | 根据仓库UUID(由CreateRepository接口返回)获取仓库信息。返回包含id,name,组名,仓库访问URL。 | |
| 获取代码提交行数 | hcloud CodeArtsRepo ShowStatisticCommit/v3 | 获取指定日期内代码仓指定分支的代码提交行数。 | |
| 获取代码提交行数 | hcloud CodeArtsRepo ShowStatisticCommitV3/v3 | 获取指定日期内代码仓指定分支的代码提交行数。 | |
| 下载仓库 | hcloud CodeArtsRepo ShowRepositoryArchive/v3 | 按照指定格式下载仓库。 | |
| 新建保护分支 | hcloud CodeArtsRepo AddProtectBranchV2/v3 | 新建保护分支。 | |
| 获取仓库分支列表 | hcloud CodeArtsRepo ListBranchesByRepositoryId/v3 | 获取仓库分支列表。 | |
| 获取仓库合并请求列表 | hcloud CodeArtsRepo ListMergeRequest/v3 | 获取仓库合并请求列表。 | |
| 获取仓库合并请求详情 | hcloud CodeArtsRepo ShowMergeRequest/v3 | 获取仓库合并请求详情。 |
V2Project
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询用户的所有仓库 | hcloud CodeArtsRepo ListUserAllRepositories/v3 | 获取用户的所有仓库信息。 | |
| 创建项目、仓库 | hcloud CodeArtsRepo CreateProjectAndRepositories/v3 | 创建项目后,创建仓库组由后台生成方式,传入参数:仓库名、模板id、是否导入项目成员、归属项目。 | |
| 创建项目并fork仓库 | hcloud CodeArtsRepo CreateProjectAndforkRepositories/v3 | 创建仓库后fork仓库传入参数:仓库名、是否导入项目成员、归属项目。 | |
| 查询项目下的所有仓库 | hcloud CodeArtsRepo ShowAllRepositoryByTwoProjectId/v3 | 获取仓库列表,模糊查询支持范围,如果未传入project uuid,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。 | |
| 分支关联工作项 | hcloud CodeArtsRepo AssociateIssues/v3 | 分支关联工作项。 |
File
RepoMember
Commit
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询某个仓库的提交信息 | hcloud CodeArtsRepo ListCommits/v3 | 根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。 | |
| 创建提交 | hcloud CodeArtsRepo CreateCommit/v3 | 能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。 | |
| 查询某个仓库的特定提交信息 | hcloud CodeArtsRepo ShowSingleCommit/v3 | 获取由commit id或分支或标记的名称标识的特定提交。 | |
| 查询某个仓库的提交差异信息 | hcloud CodeArtsRepo ShowDiffCommit/v3 | 根据commit id查询提交差异信息。 |
WebHook
Discussion
User
Project
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取一个项目下可以设置为公开状态的仓库列表 | hcloud CodeArtsRepo GetProductTemplates/v3 | 获取一个项目下可以设置为公开状态的仓库列表 | |
| 获取一个项目下可以设置为公开状态的仓库列表 | hcloud CodeArtsRepo ListProductTwoTemplates/v3 | 获取一个项目下可以设置为公开状态的仓库列表 | |
| 获取项目下所有仓库信息 | hcloud CodeArtsRepo GetAllRepositoryByProjectId/v3 | 获取仓库列表,模糊查询支持范围,如果未传入project_id,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。 | |
| 校验指定项目下的仓库名 | hcloud CodeArtsRepo ShowRepositoryNameExist/v3 | 一般创建仓库时调用。通过传入项目ID,获取方式请参见获取项目ID。仓库名,来判断仓库是否重名。 |
v2仓库管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建分支 | hcloud CodeArtsRepo CreateNewBranch/v3 | 根据仓库id在指定仓库中创建分支。 |