获取git-code代码仓分支 - ShowGitCodeRepositoryBranches

功能介绍

获取git-code代码仓分支

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

GET /v1/code/git-code/{endpoint_id}/branches

表1 路径参数
参数	是否必选	参数类型	描述
endpoint_id	是	String	参数解释：拓展点id。约束限制：不涉及。取值范围：数字、小写字母组合。

表2 Query参数
参数	是否必选	参数类型	描述
page	否	Integer	参数解释：分页页码，表示从此页开始查询。约束限制：不涉及。取值范围： page大于等于1。默认取值： 1
page_size	否	Integer	参数解释：每页显示的条目数量。约束限制：正整数。取值范围： page_size小于等于100。默认取值： 10
search	否	String	参数解释：查询过滤条件。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
repo_id	否	String	参数解释：代码仓ID，使用codehub必填。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
limit	否	Integer	参数解释：每页显示的条目数量，limit大于0小于等于100。约束限制：不涉及。取值范围：只能使用数字，大于0小于等于100。默认取值： 10
offset	否	Integer	参数解释：分页页码，表示从此页开始查询。约束限制：不涉及。取值范围：只能使用数字，大于等于0。默认取值： 0

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
result	Array of GitCodeBranch objects	结果
error	Object	返回错误信息
status	String	返回状态信息

表4 GitCodeBranch
参数	参数类型	描述
name	String	参数解释：分支名称。约束限制：不涉及。取值范围：不涉及。
commit	commit object	提交记录

表5 commit
参数	参数类型	描述
id	String	参数解释：提交记录id。约束限制：不涉及。取值范围：不涉及。
title	String	参数解释：提交记录标题。约束限制：不涉及。取值范围：不涉及。
message	String	参数解释：描述信息。约束限制：不涉及。取值范围：不涉及。
created_at	String	参数解释：创建时间。约束限制：不涉及。取值范围：不涉及。
author_name	String	参数解释：修改人。约束限制：不涉及。取值范围：不涉及。
committer_name	String	参数解释：提交人。约束限制：不涉及。取值范围：不涉及。
committed_date	String	参数解释：提交时间。约束限制：不涉及。取值范围：不涉及。

请求示例

GET https://{endpoint}/v1/code/git-code/{endpoint_id}/branches

响应示例

状态码：200

{
  "result" : [ {
    "name" : "main",
    "commit" : {
      "id" : 12,
      "title" : "修改xxx问题",
      "message" : "修改xxx类",
      "created_at" : "2024-01-01 12:00:00",
      "author_name" : "test1",
      "committer_name" : "test2",
      "committed_date" : "2024-01-01 12:00:00"
    }
  }, {
    "name" : "master",
    "commit" : null
  } ],
  "error" : null,
  "status" : "success"
}